Steps for Getting Started

  1. Create your free trial account on the Attom Developer Platform to get an API key to use when calling the API.

  2. Explore the details of our APIs to get a better idea of the data available in each and the calls you would use to collect the data.

  3. Use our interactive docs to make sample API calls and use our guides to get started with Curl or Postman.

  4. Speed up your development with our content templates to plug into your application. View them here.

Guides

Getting Started with cURL - This guide covers the basics like displaying properties within a particular city, looking at a property’s valuation and displaying recent sale prices within a given neighborhood.

Postman Guide - Postman is a Web REST client that allows you to enter and monitor HTTP requests and responses. It is available in the Chrome Web Store and is a great way to get familiar with our APIs and the data returned by different calls.

Postman Examples- Once you have setup your Postman environment, you can import pre-built collections for the Property and Area APIs.


Need some inspiration? Our Chief Solutions Architect built a demo app using the APIs. Are you building something cool? We’d love to hear about it!

Building a full application means getting to know the various resources and packages in the API. The following are the most important concepts that we go into more detail about below in the documentation.

  1. URL Structure
  2. Headers
  3. Resources & Packages
  4. Default Behavior
  5. Search & Sorting
    1. Some example requests

Security

All requests to all endpoints require you to specify your unique API key. The API Key is assigned to you by Attom and is used to identify and authorize each request. Your API key should be kept private, and should never be displayed publicly.

Response Codes

All successful responses are returned in JSON or XML, depending on the response format you request. Only queries that respond with a 200 response code (successfully completed), are counted towards monthly allowances and overages. Beyond standard HTTP codes you will find custom status codes in the “Status” element of the response body.


Status Code
Description
200 OK
Standard HTTP successful response
400 Bad Request
Standard HTTP invalid request response
401 Unauthorized
Standard HTTP unauthorized access response
500 Internal Server Error
 
There was an unexpected error on our server. If you see this please contact datacustomercare@attomdata.com


Property API

Overview

The Property API is designed to help you to integrate U.S. property information into any application that you are building. It returns data from beds/baths/sq.footage to sales history, AVM, schools, and owner/mortgage information.

Data Sources

The data provided in the Property API is derived from county public records. It includes the most up-to-date data publicly available from the counties that publish it.


Data Type
Update Frequency
Approx. Count
Property Records
Monthly by county
150 Million
Assessment/Tax
Monthly by county
150 Million
Valuations (AVM)
Monthly national
94 Million
Historical Sales
Total national
97 Million
Sales Transactions
Weekly updates
100 Thousand
School Data
Quarterly updates
127 Thousand

Interactive Docs

 




API Structure

Production Endpoint

The main endpoint for the property search engine API is:

https://search.onboard-apis.com/propertyapi/v1.0.0/Resource/Package?{parameters}

Example

https://search.onboard-apis.com/propertyapi/v1.0.0/property/detail?id=1234

Headers

There are two required headers:

  1. Accept - set to either
    1. application/json
    2. application/xml
  2. APIKey - include the API Key assigned to you.

Resources & Packages

Our data is organized into a set of resources. While all resources ultimately relate to a property (or piece of real estate) they contain different topics. We have also created “Packages” that summarize specific fields for ease of use. The packages available depend on the type of data (resource) being searched. You’ll find the available Resources and Packages below.

Resources

PROPERTY

Use the /property resource to get detailed property characteristics for a property or list of properties.

What kinds of questions can data from the /property resource help answer?

  • What properties fall within a radius of a given point (lat/long)?
  • Are there properties within a zip code with property taxes of a given range?
  • Can I validate the authenticity of the owner listed for a property?
  • What data is available about a new property owner?
  • What properties in a given area have the most current equity or are close to the end of their loan?


Check out the Interactive Docs to test out more of the capabilities of the property resource.

SALES TREND

Use the /salestrend resource to get two years of average or median sale price and sale counts within a zip code for monthly, quarterly, and yearly intervals.

What kinds of questions can data from the /salestrend resource help answer?

  • How do recent sales within a zip code compare to my houses valuation?
  • Are the home sales increasing in amount and count in my area?

SCHOOL

Use the /school resource to get schools within attendance zones around a property, private and public schools within a radius and school details. Note that some schools are not associated with a school district because of a variety of rules in different state. View the list here.

What kinds of questions can data from the /school resource help answer?

  • Which schools could my kids attend if I live at a certain property?
  • What private schools are within a 10 mile radius of a given property?
  • What is the test rating, enrollment rates, and special programs offered at a specific school?
ASSESSMENT

Use the /assessment resource to get assessments, assessed values and taxes on a property or list of properties.

What kinds of questions can data from the /assessment resource help answer?

  • What are the assessment details of properties within a specific area?
  • What is the last known tax amount and assessment for a specific property?
  • What assessments were added within a given date range?
AVM

Use the /avm resource to display the “automated valuation model” (AVM) calculation of a property or list of properties.

Can AVM values be calculated without having property characteristics like, square footage, beds, baths?

Yes. Although it's important to note how an AVM's confidence score can be affected. Below are a couple different scenarios:

Property details come from the public county records and coverage varies county to county. Some counties simply don't provide this level of detail and all properties used to calculate the valuation would effectively be in the same ‘boat’. In this situation you would expect confidence scores to be a bit higher.

However, if the missing attributes are isolated to a single property and other comparable properties used in the valuation have this data, this may negatively affect the confidence score.

* The “scr” attribute represents the confidence in the calculation.
SALE

Use the /sale resource to return information pertaining to the most recent sale of a property or list of properties.

What kinds of questions can data from the /sale resource help answer?

  • What is the last sale price of all the properties within this specific area?
  • What properties have sold over the last three months within this price range in this ZIP code?
  • What is the the last sale on this specific property?
SALES HISTORY

Use the /saleshistory resource to get information about the sales history of a property. Recorded sales history data can be found based on a property’s ID or address.


Note: This is accessible for a single property per request.


ATTOM provides 10 years of sales history data.
ALL EVENTS

Use the /allevents resource to get information about all events that have occurred on a specific property. This includes assessments, AVM and sales transactions. Note: This is accessible for a single property per request.


Packages

The table below shows what packages are available for each resource with a brief descriptions.

Package Description
/ID A set of IDs associated with a record or list of records
/Address Address and location information of a record or list of records
/Snapshot Summary information typically used for limited display, data points include: address info, property type, beds/baths and property type.
/Detail Rich property data including lot size, property type, year built, bath/beds, construction type, utilities etc.
/DetailMortgage Only available for the /Property resource. Detailed property data with mortgage information included.
/DetailOwner Only available for the /Property resource. Detailed property data with owner information included.
/DetailMortgageOwner Only available for the /Property resource. Detailed property data with mortgage and owner information included.
/Detailwithschools Only available for the /School resource. Detailed property data and schools within the attendance zone of the property.

Default Behavior

There is some default behavior to be aware of:

Setting Value
Maximum number of records in a single response 10,000
Default radius if not supplied 5 miles
Maximum radius allowed 50 miles
Maximum sort values 1
Default sort order Desc
Maximum number of GeoIDs in a single request 3
Default sort, radius search Distance Desc
Default sort, non-radius searches CalendarDate Desc

Search Filters

In addition to Resources and Packages, there are also a number of other filters that may be added to a request to help narrow down results. The filters and some examples of how they might be used are outlined below.

If you are looking to add multiple filters to your query, you can add pipe delineation ("|") to your API call. For example, if you wanted to search for single family resident and apartment property types, you could add "&propertytype=sfr|apartment" to your query to return results for both types.

Filter Name Filter Type Description Example
ID Single Value Onboard-assigned property ID ID=2517215110001
Fips Single Value Fips code for a property fips=04013
Filetypetext Single Value Type of School Filetypetext=Private
Absentee or Owner-occupied Status Single Value Owner's absentee or occupied status absenteeowner=occupied absenteeowner=absentee
APN Single Value Assessor’s parcel number APN=11701014061700000
Address Single Value Property postal address address1=468%20SEQUOIA%20DR address2=SMYRNA,%20DE%2019977
Latitude / Longitude Single Value Latitude and Longitude pair Note: MUST include a radius latitude=39.21523130910493 longitude=-75.62095642089844
GeoID Multi-Value ATTOM geographic identifier. These may be found in ATTOM boundary and other products. The Property API currently returns the following geographies: PL = Place, DB = School District, SB = School, ND = Maponics Neighborhood, RS = Maponics Residential Subdivision, MT = Maponics Metro, NH = Deprecated Neighborhood Boundary geoID=NH00016389|NH00016398
Radius Single Value Circular radius distance in miles Note: May be used in conjunction with Latitude / Longitude or Address input radius=10
Beds Range The number of bedrooms minBeds=2 maxBeds=4
BathsTotal Range The number of bathrooms minBathsTotal=1 maxBathsTotal=3
PostalCode Single Value Postal ZIP Code postalCode=19977
PropertyType Single Value Standardized property type propertyType=apartment
CityName Single Value City name cityName=Smyrna
AddedDate Range The date the record was added to the system startAddedDate=2014/01/04 endAddedDate=2015/05/01
CalendarDate Range The date the record was last updated startCalendarDate=2014/01/04 endCalendarDate=2015/05/01
ApprTtlValue Range Appraised Total Value minApprTtlValue=100000 maxApprTtlValue=200000
ApprImprValue Range Appraised Improvement Value minApprImprValue=100000 maxApprImprValue=200000
ApprLandValue Range Appraised Land Value minApprLandValue=100000 maxApprLandValue=200000
AssdTtlValue Range Assessed Total Value minAssdTtlValue=100000 maxAssdTtlValue=200000
AssdImprValue Range Assessed Improvement Value minAssdImprValue=100000 maxAssdImprValue=200000
AssdLandValue Range Assessed Land Value minAssdLandValue=100000 maxAssdLandValue=200000
MktTtlValue Range Market Total Value minMktTtlValue=100000 maxMktTtlValue=200000
MktImprValue Range Market Improvement Value minMktImprValue=100000 maxMktImprValue=200000
MktLandValue Range Market Land Value minMktLandValue=100000 maxMktLandValue=200000
AVMValue Range Automated Valuation Model Value minAVMValue=150000 maxAVMValue=250000
SaleAmt Range Amount of the last sale on the property minSaleAmt=200000 maxSaleAmt=350000
TaxAmt Range Amount of the last taxes on the property minTaxAmt=4000 maxTaxAmt=6000
SaleSearchDate Range Sale date for search purposes startSaleSearchDate=2014/01/01 endSaleSearchDate=2014/12/31
SaleTransDate Range Date the sale transaction occurred startSaleTransDate=2014/01/01 endSaleTransDate=2014/12/31
UniversalSize Range The property size (in square feet) that best reflects the most common measurement within a county minUniversalSize=1200 maxUniversalSize=1800
LotSize1 Range Lot size in acres minLotSize1=.5 maxLotSize1=1.5
LotSize2 Range Lot size in square feet minLotSize2=12000 maxLotSize2=20000

Search Filter Examples

Show me all of the properties that have an assessed total value within this range that are within this ZIP Code.

https://search.onboard-apis.com/propertyapi/v1.0.0/assessment/detail?postalcode=11215&minAssdTtlValue=1000000&maxAssdTtlValue=2500000



Show me all of the properties that have sold during a specified time frame within this neighborhood.

https://search.onboard-apis.com/propertyapi/v1.0.0/sale/snapshot?startSaleSearchDate=2015/05/01&endSaleSearchDate=2015/08/31&geoId=ND0000498309



Show me all the residential lots in Chicago.

https://search.onboard-apis.com/propertyapi/v1.0.0/property/snapshot?cityname=chicago&propertytype=residential+lot



Want to know all of the property types available? Check them out here.

Show me all the properties that fall within a radius of this point.

https://search.onboard-apis.com/propertyapi/v1.0.0/property/snapshot?latitude=30.2500&longitude=-97.7500&radius=2



Trying out these examples in Postman? Don’t forget, you’ll need to include your API Key in the header for these examples to work.

Order By (Sorting Results)

Guess what? API Results can be sorted by in either ascending or descending order by several select fields. You’ll the list of sortable fields and examples of how they might be used below. Don’t forget, you can play around with sortable fields in our Interactive Docs!
Name Description Example
Distance Distance in miles from the start point orderBy=distance asc
CalendarDate The date the record was last updated orderBy=calendarDate asc
PropertyType Standardized property type orderBy=propertyType desc
SaleAmt Amount of the last sale on the property orderBy=saleAmt desc
AvmValue Automated Valuation Model Value orderBy=avmValue desc
AssdTtlValue Assessed total value orderBy=AssdTtlValue desc
SaleSearchDate Last sale date orderBy=SaleSearchDate asc
SaleTransactionDate Date the sale transaction occurred orderBy=SaleTransactionDate asc
Beds Total beds count orderBy=beds desc
BathsTotal Total bathrooms count orderBy=bathsTotal asc
UniversalSize The property size (in square feet) that best reflects the most common measurement within a county orderBy=universalSize asc
LotSize1 Lot size in acres orderBy=lotSize1 desc
LotSize2 Lot size in square feet orderBy=lotSize2 desc

Sort Examples

Show me all of the properties that have sold within the radius of a specific point and are sorted in descending order by their sale amount.

https://search.onboard-apis.com/propertyapi/v1.0.0/sale/snapshot?latitude=30.2500&longitude=-97.7500&radius=2&orderBy=saleAmt+desc



Show me all of the single family residences within this zip code ordered by their number of bedrooms in descending order.

https://search.onboard-apis.com/propertyapi/v1.0.0/property/detail?postalcode=78704&propertytype=sfr&orderBy=beds+desc



Show me all the assessments made on properties within the radius of a specific point ordered by their distance from the point.

https://search.onboard-apis.com/propertyapi/v1.0.0/assessment/snapshot?latitude=39.731234&longitude=-75.581182&radius=1&orderby=distance+ASC


Pagination

You may request a specific page and number of results per page. By default the API will return page one and ten results per page. To modify the default behavior you may use the following arguments:
Argument Value Example
Page Integer page=2
PageSize Integer pageSize=20

Standard Response Information

A standard response from the property API will include the following structure to help you handle different response codes, page sizes, and number of records. This can be found at the top of the response:

{

"status": {

"version": "1.0.0",

"code": 0,

"msg": "SuccessWithResult",

"total": 1,

"page": 1,

"pagesize": 10

},

Status Codes

The following table highlights the expected status codes from the system. Beyond standard HTTP codes you will find custom status codes in the “Status” element of the response body.

Status Description
-5 Invalid Parameter in Request You passed an invalid search parameter
-4 Invalid Parameter Combination You passed an invalid combination of parameters
-3 MissingAPIKey You did not include the APIKey in your request
-2 System Not Responding There is a failure within the API
-1 System Not Responding There is a failure within the API
0 SuccessWithResult Your request was successful and returned results
1 SuccessWithoutResult Your request was successful but returned no results
10 Invalid Date Format You did not pass the date value as YYYY/MM/DD
11 Invalid Date Range Your date range contains an error such as conflicting start and end dates
12 Sort Value Exceeded You passed more than the allowed number of sort values. See Default Behavior.
13 Invalid Sort Value You passed a value that cannot be used for sort. See Sort Values.
14 Invalid Search Distance You passed a search distance beyond the maximum allowed. See Default Behavior.
15 Invalid AVM Value Range Your AVM Value range contains an error such as a higher minimum value than maximum value.
16 Invalid Sale Amount Range Your Sale Amount range contains an error such as a higher minimum value than maximum value.
17 Invalid Tax Amount Range Your Tax Amount range contains an error such as a higher minimum value than maximum value.
18 Invalid Appr Impr Range Your Appraised Improvement range contains an error such as a higher minimum value than maximum value.
19 Invalid Appr Land Range Your Appraised Land range contains an error such as a higher minimum value than maximum value.
20 Invalid Appr Ttl Range Your Appraised Total range contains an error such as a higher minimum value than maximum value.
21 Invalid Assd Impr Range Your Assessed Improvement range contains an error such as a higher minimum value than maximum value.
22 Invalid Assd Land Range Your Assessed Land range contains an error such as a higher minimum value than maximum value.
23 Invalid Assd Ttl Range Your Assessed Total range contains an error such as a higher minimum value than maximum value.
24 Invalid Mkt Impr Range Your Market Improvement range contains an error such as a higher minimum value than maximum value.
25 Invalid Mkt Land Range Your Market Land range contains an error such as a higher minimum value than maximum value.
26 Invalid Mkt Ttl Range Your Market Total range contains an error such as a higher minimum value than maximum value.
27 Invalid Universal Size Range Your Universal Size range contains an error such as a higher minimum value than maximum value.
28 Invalid Year Built Range Your Year Built range contains an error such as a start date later than your end date.
29 Invalid Lot Size 1 Range Your Lot Size 1 range contains an error such as a higher minimum value than maximum value.
30 Invalid Lot Size 2 Range Your Lot Size 2 range contains an error such as a higher minimum value than maximum value.
31 Invalid Beds Range Your Beds range contains an error such as a higher minimum value than maximum value.
32 Invalid Baths Range Your Baths range contains an error such as a higher minimum value than maximum value.
33 GeoID Value Exceeded You included more GeoIDs than are allowed in a single search. See Default Behavior.
34 Invalid GeoID Value You provided an invalid GeoID and should check that the data is correct.
100 Unauthorized You are not authorized to access the resource
201 Geocoder Search No Result. The geocoder could not find a match for the input address. Try again.
203 Geocoder Search ZipCode Not Positioned. The ZIP Code provided could not be properly positioned.
204 Geocoder Search ZipCode Required. The address provided did not include a ZIP Code. Please add the ZIP Code and try again.
205 Geocoder Invalid Service.
206 Geocoder Service Temporarily Unavailable. The geocoding service that accepts and translates addresses is currently unavailable. Radius searches cannot be performed.
207 Geocoder Unexpected Error. An unexpected error occurred in the geocoding service. Try the search again.
208 Geocoder Value Format Error. There was an error in the format of the request to the geocoding service. Check the input format and try again. See Search Filters and review Address format.
211 Success with results. Address positioning is approximate to the ZIP Code. The input address has been located with ZIP level precision, and a record is available.
210 Geocoder Search Results Address Not Identified. The input address could not be identified. Please try again.
212 Success without results. No data available for this address. The input address has been located with ZIP level precision, but a record is not available.
Need help with address formatting?

Check out this example request
https://search.onboard-apis.com/propertyapi/v1.0.0/sale/detail?address1=586+FRANKLIN+AVE&address2=brooklyn+NY+11238


A space character in the query string may be encoded as either “%20” or “+”. You can use either, most people opt for “+” as it’s more human readable and fewer bytes.

Data Dictionary

This data dictionary represents all of the fields currently available in the Property Search Engine API. Different resource and package combinations off access to specific fields within this dictionary and not all fields are available in each package. You will find downloadable documentation and other user guides here.

Field Name Suggested Display Name Description
absenteeInd Absentee Owner Indicator Owner status description - "Absentee Owner" or "Owner Occupied" - Logic based
absenteeownerstatus Absentee Owner Status Owner status code - "A" or "O" - Logic based
accuracy Location Accuracy The precision, or positional accuracy of the point coordinates
ownerAfterSpouse Additional Owner after Spouse Additional Owners after the Spouse's Name - i.e.: First Owner - JEREZ,ELIAS, Second Owner - JEREZ,AMBIOSIX, Addtl Owner - EVELISA,CRUZ D
apn Assessor's Parcel Number Primary Parcel Number and unique identifier within the county/jurisdiction
apnOrig Original Assessor's Parcel Number This is populated if a property has previously been split or came from another property ID
apprimprvalue Appraised Improvement Value Appraised Value of the improvement(s)
apprlandvalue Appraised Land Value Appraised Value of the land
apprttlvalue Appraised Total Value Total Appraised Value
archStyle Architectural Style Indicates the structural style or the presence of specific style elements in the structure
armsLengthIdent Arms Length Sale Identifier Deed representing a transfer between two otherwise unrelated or affiliated parties.
assdImprPerSizeUnit Assessed Improved Value Per (Square Foot) The assessed improved value per square footage of the property
assdimprvalue Assessed Improved Value Assessed Value of the improvement(s)
assdLandPerSizeUnit Assessed Land Value Per (Square Foot) The assessed land value per square footage of the property
assdlandvalue Assessed Land Value Assessed Value of the land
assdTtlPerSizeUnit Assessed Total Per (Square Foot) The assessed total value per square footage of the property
assdttlvalue Assessed Total Value Total Assessed Value
atticsize Attic Size The sum area of the attic of all buildings on the property.
attomID Attom ID ATTOM Data's Unique parcel identifier.
auctionDateTime Auction Date and Time Date of the foreclosure auction in YYYY-MM-DD format.
auctionLocation Auction Location The start time of the foreclosure auction.
bathfixtures Bath Fixtures Number of bathroom fixtures in the entire parcel (sink, toilet, bath, shower) and could be used to calculate the number of bathrooms
baths1qtr Quarter Baths Count Number of Quarter Baths - typically sink only
baths3qtr Three Quarter Baths Count Number of Three-Quarter Baths - typically sink, toilet, and shower (Very similar to full bath)
bathscalc Baths Total Calculated The sum of the values of the bathrooms
bathsfull Full Baths Count Number of Full Baths - tyically sink, toilet, shower and/or bath tub
bathshalf Half Baths Count Number of Half Baths - typically sink and toilet
bathstotal Total Baths The total number of rooms that are utilized as bathrooms (Includes partial bathrooms and value may be interpreted)
beds Total Bedrooms The total number of rooms that can be qualified as bedrooms
beneficiaryUnparsedAddress Address of Beneficiary Unparsed Mailing Address of the beneficiary. i.e. 123 Main St Anytown CA 00001
beneficiaryUnparsedCity City of Beneficiary Mailing City of the beneficiary. i.e. 123 Main St, Anytown CA 00001
beneficiaryUnparsedName Name of Beneficiary Beneficiary Full Name
beneficiaryUnparsedState State of Beneficiary Mailing State of the beneficiary. i.e. 123 Main St, Anytown CA 00001
bidAmount Auction Bid Amount Anticipated Opening Bid at the scheduled auction
buildingshapedescription Building Shape Description Building Shape Description
buildingshapetype Building Shape Type Building Shape Type
bldgsize Building Size Total square feet of all structures on the property
bldgsNum Number of Buildings The number of buildings on the property
bldgType Building Type Indicates the Building Style
blockNum Block Number Block number
bsmtFinishPercent Finished Percent of Basement Percentage of the finished basement footage against the total basement footage
bsmtsize Basement Size The total area of the basement, in square feet
bsmttype Basement Type Indicates if the basement is finished or unfinished
buyerName Buyer Name Name of Buyer(s) on the recorded document
calcimprind Calculated Improved Value Indicator Derived Assessed Value of the improvement(s) Indicator
calcImprPerSizeUnit Calculated Improved Value Per (Sq Ft) A field calculated to show the per square foot value of the property
calcimprvalue Calculated Improved Value Derived Assessed Value of the improvement(s) used to calculate property tax
calclandind Calculated Land Value Derived Assessed Value of the land Indicator
calcLandPerSizeUnit Calculated Land Value Per (Sq Ft) A field calculated to show the per square foot value of the land
calclandvalue Calculated Land Value Derived Assessed Value of the land used to calculate property tax
calcttlind Calculated Total Value Indicator Derived Total Assessed Value Indicator
calcttlvalue Calculated Total Value Derived Total Value used to calculate property tax
calcValuePerSizeUnit Calculated Value Per (Sq Ft) A field calculated to show the per square foot value of the property
careofname C/O Name "Care Of" name, if any
cashormortgagepurchase Cash/Mortgage Purchase Indicates if the transaction sale is a cash or mortgaged purchase
censusBlockGroup Census Block Group US Census assigned Block Group for subject property.
censusTractIdent Census Tract Code US Census assigned Tract Code for subject property.
condition Building Condition Indicates the Building Condition
constructionloan Construction Loan Indicates if the loan is a contruction loan
constructiontype Construction Type Construction Type
coolingtype Cooling Type Indicates the method or system used to provide cooling
corporate indicator Corporate Indicator Indicates if owner is a Corporation
country Country The ISO-3166-2 country code
countrySecSubd Country Secondary Subdivision The "county" name in the U.S.
countrySubd Country Subdivision For the U.S. this is a state abbreviation
countyuse1 County Use Type One County-specific use code which is used to map the Universal Land Use Code field
dateOfLastQuitClaim Last Quit Claim Date Recording Date of the most recent Quit Claim recording, or similar. i.e. Interspousal/Gift/etc...
deedInLieuOfIndicator Deed in Lieu of Foreclosure Flag that indicates that the sale was a Deed_In_Lieu event
delinquentAmount Delinquent Amount For Preforeclosure recordings, the amount that is in delinquent
delinquentyear Delinquent Year The tax year for which property taxes have not been paid by the owner or impound account
depth Lot Depth Indicates the lot depth, in feet
distressType Distress Type ATTOM Data derived distress scenario.
mortgage duedate Loan Due Date The date the loan represented on the third loan is due
elevation Elevation The elevation of the property if available
energyType Energy Type Indicates the available electrical source
equityflag Loan Equity Flag Indicates that the Loan is an Equity Type Loan
eventDate Event Date The date when the value was determined
exemption amount1 Homeowner exemption amount Homeowner exemption amount
exemption amount2 Disabled person exemption amount Disabled person exemption amount
exemption amount3 Senior person exemption amount Senior person exemption amount
exemption amount4 Veteran exemption amount Veteran exemption amount
exemption amount5 Widow exemption amount Widow exemption amount
fips Federal Information Processing Standard Code 5 digit numeric Federal Information Processing Standard (FIPS) code combining state and county codes where the property is located
floors Floors Description This field indicates the primary type of flooring in the structure
foreclosure Foreclosure Indicates if the transaction is a foreclosure/adverse possession instrument
defaultedLoanDocumentLoanNumber Foreclosure Loan Document Number Recorder's Instrument Number of the original loan document.
foundationtype Foundation Type Indicates the type of foundation for the primary structure on the property
fplccount Fireplace Count Indicates the number of fireplaces on a property
fplcind Fireplace Indicator Indicates the presence/absence of a fireplace
fplctype Fireplace Type Indicates the type of fireplace the property contains
frameType Frame Type Construction materials used for the interior walls
frontage Lot Frontage Indicates the lot width, in feet
fullcashvalue Total Assessed Value Total Assessed Value
garagetype Garage Type Indicates if a garage exists on the property and any additional information about the garage such as attached / detached, etc...
grosssize Gross Size Gross square feet of all structures on the property
grosssizeadjusted Gross Size Adjusted Adjusted Gross Square Footage where applicable, otherwise populated with Building Square Footage
groundfloorsize Ground Floor Size The sum of ground floor living square footage (May include unfinished square footage)
heatingfuel Heating Fuel Indicates the primary heating fuel used
heatingtype Heating Type Indicates the method or system used to provide heat
high High Value Max range AVM value
improvementpercent Improvement Percent Percentage of the improvement value against the total value
imprType Building Improvement Type Indicates the Building Type
interestMargin Loan 1 Interest Margin A fixed percentage rate that is added to an index value to determine the fully indexed interest rate of an adjustable rate mortgage for the first loan
interest2Margin Loan 2 Interest Margin A fixed percentage rate that is added to an index value to determine the fully indexed interest rate of an adjustable rate mortgage for the second loan
interest3Margin Loan 3 Interest Margin A fixed percentage rate that is added to an index value to determine the fully indexed interest rate of an adjustable rate mortgage for the third loan
interestrate Loan Interest Rate Interest rate for the loan
interestratetype Loan Interest Rate Type Indicates the type of interest rate
interfamily Inter Family Indicates that the latest transfer was between related/family members
lastModified Last Modified Date The date the record was last modified
latitude Latitude The latitude of the property in degrees
legal1 Legal Description Legal description as provided in the tax roll and / or recorded instruments
lender address Lender Address Street number and street name segment of the Lender's address
lender city Lender City City segment of the Lender's address
lender companycode Lender Company Code Unique Lender Code assigned to the respective lender's name below
lenderFirstName Lender First Name For private individuals, the first name of the first lender. For companies, the complete name of the first lender
lenderLastName Lender Last Name For private individuals, the last name of the first lender
lender state Lender State City segment of the 1st Lender's address
lender zip Lender Zip ZIP+4 Code segment of the 1st Lender's address
levels Number of Levels The number of stories for the buildings on the property (If multiple buildings exist, the values are aggregated)
line1 Address Line One First line of the mailing address
line2 Address Line Two Second line of the mailing address
livingsize Living Size Living square feet of all structures on the property
ident Loan Document Number Loan's Document number created from document book/page or instrument number.
loantypecode Loan Type Loan type
locality Locality The local city, town or hamlet of the postal address
locType Location Type The type of location such as waterfront, beach, airport, etc...
longitude Longitude The longitude of the property in degrees
lotnum Lot Number Lot number
lotsize1 Lot Size One Indicates the lot size, in acres
lotsize2 Lot Size Two Indicates the lot size, in square feet
low Low Value Min range AVM value
mailingaddressoneline Mailing Address One Line One line mailing address
matchCode Address Match Code The indication of how well the address was matched against postal data
mktimprvalue Market Improved Value Market Value of the improvement(s)
mktlandvalue Market Land Value Market Value of the land
mktttlvalue Market Total Value Total Market Value
mobileHomeInd Mobile Home Indicator Indicates if there is a mobile home on the parcel (logic based)
monthlyChgPct Monthly Change Percent The month over month percent change in this property's estimated value
mortgage1interestIndex Loan 1 Interest Rate Index First Loan Interest Index
mortgage1interestRateMax Loan 1 Max Interest Rate First Loan Interest Rate Max
mortgage2interestIndex Loan 2 Interest Rate Index Second Concurrent Loan Interest Index
mortgage2interestRateMax Loan 2 Max Interest Rate Second Concurrent Loan Interest Rate Max
mortgage3interestIndex Loan 3 Interest Rate Index Third Concurrent Loan Interest Index
mortgage3interestRateMax Loan 3 Max Interest Rate Third Concurrent Loan Interest Rate Max
multiapn Multi APN Description Used to indicate a multiple parcel transaction.
originalLoanAmount Original Loan Amount Original amount of loan in default.
originalLoanDate Original Loan Date Contains the official filing date for the original loan transaction that is normally stamped or printed on the document in YYYY-MM-DD format.
owner description Owner Description Identifies if first owner is a company, individual, government or unknown
owner type Owner Type Identifies if first owner is a company, individual, government or unknown
zoningtype Property Zoning Type The jurisdiction-specific zoned use value. Typically codified by the controlling jurisdiction.
quitClaimFlag Quit Claim Indicator Indicates that the transaction is a Quit Claim.
recorderThroughDate Last Recording Date Last Recording Date available for respective county from ATTOM Data
refiflag Refinance Flag Refinance Flag
siteZoningIdent Site Zoning Identifier The jurisdiction-specific zoned use value. Typically codified by the controlling jurisdiction.
term Loan Term Loan Term in Months
trustDeedDocumentNumber Trust Loan Document Number Loan Document Number
trustIndicator Owner Trust Indicator Flag that indicates if the owner is a trust.
trusteeCity Trustee City Name Anytown CA 90001-0001 - Trustee's address city name.
trusteeFirstName Trustee First Name First Name of Trustee or attorney handling the foreclosure event.
trusteeHouseNumber Trustee House Number 123 1/2 N Main St - Trustee's address house number and fraction.
trusteeLastName Trustee Last Name Last Name of Trustee or attorney handling the foreclosure event.
trusteePostalCode Trustee Postal Code Anytown CA 90001-0001 - Trustee's address Zip Code.
trusteeSaleNumber Trustee Unique Number Unique number assigned by the trustee to track status of foreclosure and auction proceedings.
trusteeState Trustee State Anytown CA 90001-0001 - Trustee's address state.
trusteeStreetName Trustee Street Name 123 1/2 N Main St - Trustee's address street name.
trustorFirstName Trustor First Name Mortgagee's First name of borrower in default.
trustorLastName Trustor Last Name Mortgagee's Last name of borrower in default.
unitNumberIdent Unit Number Legal unit name or number. Multiple unit numbers may exist in the same field.
responseDateTime Response Date and Time API call response date and time
transactionID Transaction ID API transaction ID
JobID Job ID (user defined) User defined input replicated in the API response
LoanNumber Loan Number (user defined) User defined input replicated in the API response
PreparedBy Prepared By (user defined) User defined input replicated in the API response
ResellerID Reseller ID (user defined) User defined input replicated in the API response
PreparedFor Prepared For (user defined) User defined input replicated in the API response
statefips State FIPS Code State FIPS code
recordingDate Recording Date Date on which the instrument was officially recorded at the county. Format YYYY-MM-DD.
documentNumber Document Number Document number on the recorded instrument
sequence Record Sequence Sequence of the transaction history
transactionIdent Transaction Identifier Unique ID associated with a transaction and loan record
sellerName Seller Name Name of seller(s) on the recorded document
saleCode Sale Code Code indicating whether the sale amount is actual or estimated
mortgage amount Mortgage Amount Loan Amount for the mortgage/deed of trust
mortgage date Mortgage Date The recording date referenced/stamped on the mortgage/deed of trust

Want all fields to be returned?

All fields that are null are omitted in the JSON response by default. If you would like the JSON response to include the null fields, just add "&debug=True" to the end of the API call URL.

Example:

https://search.onboard-apis.com/propertyapi/v1.0.0/property/detail?address1=210+Hammerking+Rd&address2=Dallas+TX+75232&debug=True 


Area API

Overview

The Area API allows you to understand the relationships between various geographic areas (boundaries) that Attom provides data for. The data includes polygon and area IDs from counties and zip codes to residential subdivisions and school boundaries.

Data Sources

Our Area API includes boundary data from Maponics, the United States Postal Service (USPS) as well as selected geographic areas from the Census Bureau’s MAF/TIGER database. Learn more about how the Census defines geographic areas here.


Data Type
Update Frequency
Approx. Count
ND Maponics Neighborhood
Quarterly
40,878
RS Maponics Residential
Quarterly
446,843
MT Maponics Metro
Quarterly
502
NH Neighborhood
 
 
NO LONGER SUPPORTED
 
 
These boundaries will phased out in 2016
ST State
 
Annual
 
50 + District of Columbia
CO County
Annual
3,233
CB Core Based Statistical Area
Annual
929
PL Census Place
Annual
29,829
CS County Subdivision
Annual
36,387
ZI ZIP Code
Annual
33,144
PZ Postal Zip Code
Annual
32,147

Interactive Docs




API Structure

The main endpoint for the Area API is:

https://search.onboard-apis.com/areaapi/v2.0.0/Resource/Package?{parameters}

Example

https://search.onboard-apis.com/areaapi/v2.0.0/Boundary/Detail?areaid=12345

Headers

There are two required headers:

  1. Accept - set to either
    1. application/json
    2. application/xml
  2. APIKey - include the API Key assigned to you.

Only WKT and KML formats are supported.

Resources

This API contains three primary resources for interacting with ATTOM geographic data:

Area Hierarchy This resource allows you to determine all of the areas a specific geographic point falls within.
Boundary Detail Allows you to retrieve the coordinate points for a specific boundary.
Area Lookups Use Lookups to understand the relationships between two specific types of areas. For example, counties within a state.

You can try out all these calls in our Interactive Docs.

Area Hierarchy

Maponics Neighborhood Boundaries

Maponics delineates the geographies that matter most to customers in the areas where people live, work, and socialize. Whether you need a simple lookup of neighborhood names or want a more meaningful way to organize and present map data, this dataset is considered the industry standard by web and mobile organizations across the globe.


Maponics Residential Boundaries

Maponics Residential, provides data about the residential areas in and around metros. These boundaries delineate neighborhoods with houses, condos, and apartment complexes, and exclude those with commercial, industrial, or public spaces.


Maponics Metro Boundaries

Metros are densely populated locations are comprised of cities, towns and rural areas that are socio-economically linked to urban centers. They include urban areas in which population concentration is greater than 50,000 and population density is greater than 1,000 people per square mile.

See the map below for a visualization of Maponics Boundaries. Learn more about Maponics boundaries here.


Census Hierarchy

Incorporated Places

Places always are within a single state or equivalent entity, but may extend across county and county subdivision boundaries. An incorporated place usually is a city, town, village, or borough, but can have other legal descriptions.


County Subdivisions

County Subdivisions are the primary divisions of counties and equivalent entities. They include census county divisions, census subareas, minor civil divisions, and unorganized territories and can be classified as either legal or statistical. *NOTE: ATTOM has chosen to use either Census Place OR County Subdivision boundaries in certain areas where the geography type best fits the local understanding and designation of geographies.

See the map below for a visualization of Places and County Subdivisions within a county.

What kinds of questions can data from the Area API help answer?

  • What neighborhood, zip code or place does this point or address fall within?
  • What is the boundary for a given GEO ID?
  • Tell me all the counties within this state.
  • Tell me all the CBSAs within this state.

Standard Response Information

A standard response from the area API will include the following structure to help you handle different response codes and number of records. This can be found at the bottom of the response:

{

"xml_record": "50"

},

"status": {

"code": "0",

"long_description": "Your request was successfully processed.",

"short_description": "Success",

},

"xmlns": "https://search.onboard-apis.com/xmlns/areaapi/v.2.0.0"

}

}

Status Codes

Beyond the standard HTTP codes, you will find custom status codes in the response body.

-1 Database Connection Failed Could not open Database Connection
-2 SQL Command Failed SQL command execution failed
0 Success Your request was successfully processed
100 One or more input parameters are invalid or missing One or more input parameters are invalid or missing
4100 Invalid WKT The WKT is invalid

Data Dictionary

This data dictionary represents all of the fields currently available in the Area API.

Field Name Suggested Display Name Description
CB Core Based Statistical Area Core Based Statistical Area representing a major metro
PL City US Census Bureau designated place(city)
CO County County or county equivalent
CS County Subdivision County subdivision (town, hamlet or unincorporated place)
NH Neighborhood Neighborhood - DEPRECATED, Phasing out in 2016. Boundary Type ND should be used.
ST State U.S. State
ZI Zip Code ZCTA or Census ZIP Code Tabulation Area
PZ Postal Zip Code Postal ZIP, representing an expanded set of ZIP Codes not documented by the US Census Bureau
DB School District School District
SB School Attendance Zone School Attendance zone representing the catchment area for a specific school and grade level
ND Neighborhood Maponics defined neighborhood boundary.
RS Residential Subdivision Maponics defined residential subdivision boundary.
MT Metro Maponics defined metro boundary.
ID Geo ID (Not recommended to display) Fully formatted geography ID.
boundary Area Area geometry
geo_center_latitude Latitude Latitude component of centroid
geo_center_longitude Longitude Longitude component of centroid
WKTString Geographic Point Area geographic centroid
area Area Size Area measurement
area_unit Size Unit of Measurement Units for area measurement
name Name of Area Suggested value to use for text search, drop-downs and other search controls
type Type of Area Standard Onboard geography type code
StateID State Code State FIPS code
abbreviation State Abbreviation To letter state abbreviation
geoId Geographic Identifier Onboard's Geo ID - Not recommended to display
GeoType Geographic Indentifier Type The type of geography being searched. For example, ZI for Zip Code. See Data Sources section for all Geo ID types.
geo_key Geo ID String Full geographic identifier used for searching. Not recommended to display
xml_record Number of Records The number of records returned for the Geo ID lookup call

Which is better, full dataset file delivery or data access via API?

Neither, they are just different. The best choice for you depends on the resources you have available and the type of format you are looking for. Some companies don't have the staff or infrastructure in place to support ongoing map database management so the API is the best way for them to access geographic data.

Interested in learning more? Contact us today to discuss your business’s needs.


POI API

Overview

The Points of Interest (POI) API provides the ability to request public and private establishments in real time, based on a certain location (i.e. Address, Latitude/Longitude). Lookups are provided to further define the over 4 million establishments. All establishments are geocoded so points can easily be displayed on a map.

Data Sources

The data provided in the POI API includes data from USA, MCH as well as public sources.


Data Type
Update Frequency
Approx. Count
USA, MCH and public sources
Monthly, Nationally
4 Million

Interactive Docs




API Structure

The main endpoint for the Points of Interest API is:

https://search.onboard-apis.com/poiapi/v2.0.0/Resource/Package?{parameters}

Example

https://search.onboard-apis.com/poiapi/v2.0.0/POI/Street+Address/streetaddress=90+broad+street,+new+york,+ny;+10004

Headers

There are two required headers:

  1. Accept - set to either
    1. application/json
    2. application/xml
  2. APIKey - include the API Key assigned to you.

Resources

This API contains three primary resources for interacting with ATTOM points of interest data:

Street Address This search returns a list of POIs in proximity to an address.
Geography This search returns a list of POI in proximity to the centroid of a zip code.
Point This search returns a list of POI in proximity to a lat/long. Format should be written as follows: POINT(-74.019215,40.706554)

Default Behavior

Record Limit

The API’s response defaults to 20 Points of Interest per call. You can change this by adding a parameter called "RecordLimit" to your request.


https://search.onboard-apis.com/poisearch/v2.0.0/poi/Street+Address/?streetaddress=90+broad+street,+new+york,+ny;+10004&recordlimit=50

Search Radius

The API default search distance is 5 square miles from the address, point or zip code entered. To increase or decrease this default add a parameter called "SearchDistance" to your request.


https://search.onboard-apis.com/poisearch/v2.0.0/poi/Street+Address/?streetaddress=90+broad+street,+new+york,+ny;+10004&searchdistance=2
Street Address Format

A valid street address must be entered for results to be returned. The following format should be used: address number and street name, city, state; zip code


https://search.onboard-apis.com/poisearch/v2.0.0/poi/Street+Address/?streetaddress=90+broad+street,+new+york,+ny;+10004

Filtering

The table below shows the different fields that can be used to filter responses from the /poi/point call. Try this out in the Interative Docs.

BUSINESSCATEGORY Business category of the POI (14 available)

Sorting Options

The table below shows the different columns that can be sorted in the POI API outputs. Try this out in the Interative Docs.

NAME Name of the POI
DISTANCE Distance of the POI fromt the search point
BUSINESSCATEGORY Business category of the POI (14 available)
LOB Line of business of the POI (120 available)

Business Categories

These are 14 business categories that exist in the Point of Interest API. They are:

  1. ATTRACTIONS – RECREATION
  2. AUTOMOTIVE SERVICES
  3. BANKS – FINANCIAL
  4. EATING – DRINKING
  5. EDUCATION
  6. FARM – RANCH
  7. GOVERNMENT – PUBLIC
  8. HEALTH CARE SERVICES
  9. HOSPITALITY
  10. ORGANIZATIONS – ASSOCIATIONS
  11. PERSONAL SERVICES
  12. PET SERVICES
  13. SHOPPING
  14. TRAVEL

Helpers

We also provide three lookups to help you better understand the business categories that a POI may be classified under.

Business Categories This lookup is used to obtain a full list of business categories.
Lines of Business (LOB) This lookup can be used to get the list of LOBs that are in the system. A Line of Business belongs to a business category. A list of all available lines of business can be found at the end of POI documentation.
Geography This search returns a list of POI in proximity to the centroid of a zip code.


Implementation Tips

Business Duplication: Establishments are often associated with multiple business types or categories. For example, a Home Depot might be considered a hardware store, a garden center or an appliance store. When a business belongs to multiple business classifications, we deliver the business to you multiple times. Each instance of that business will have the same OB_ID.

The PRIMARY field can be used to determine the primary business practice at the location. If your goal is to display a set of unique businesses near a property we suggest you filter out any records from the display where PRIMARY = “OTHER”. This will ensure that each business is only listed once.


Standard Response Information

A standard response from the POI API will include the following structure to help you handle different response codes and number of records. This can be found at the bottom of the response:

{

"xml_record": "20"

},

"status": {

"code": "0",

"long_description": "Your request was successfully processed.",

"short_description": "Success",

},

"xmlns": "https://www.ist_prod.obiwebservices.com/xmlns/security/1.0"

}

}

Status Codes

The following table highlights the expected status codes from the system. Beyond standard HTTP codes you will find custom status codes in the “Status” element of the response body.

3 Address Geocoded fail The address entered could not be geocoded
5 There are no POIs within the zip code entered  
100 One or more input parameters are invalid or missing  

Data Dictionary

This data dictionary represents all of the fields currently available in the Points of Interest API.

Name Description
BUSNAME Name of business / point of interest / establishment / location.
STREET Street Address
CITY City
STATENAME State
ZIP Zip Code
COUNTYNAME County Name
PHONE Phone Number
STATE FIPS State Code
COUNTY FIPS County Code
LONGITUDE Longitude coordinates (6 points of precision to the right of the decimal).
LATITUDE Latitude coordinates (6 points of precision to the right of the decimal).
LINEOFBUS Classification of business / location.
SIC Standard Industrial Classification Code (or OB code if no SIC) indicating location type.
INDUSTRY A more specific classification of business.
FRANCHISE Indicates franchise brand if applicable.
CATEGORY General business / location category. May be used to help filter for display.
PRIMARY Indicates if the SIC is the primary business/location type associated with this location. May be used to ensure that locations do not appear more than once in result set.
COUNTY3 Three digit county FIPS code. May be useful in matching to other content.
OBID Numeric identifier for business/point of interest/establishment/location. Required to match with neighborhood lookup table. NOTE: this is not a unique record identifier, but is a unique business identifier.
GEO_MATCH_CODE_TEXT "Degree of accuracy of geocoding. Match types include the following, from most accurate to least accurate: ADDRESS MATCH, ZIP+4 CENTROID, ZIP+2 CENTROID, STREET SEGMENT MATCH, INTERSECTION MATCH, ZIP CENTROID, NO COORDINATES AVAILABLE."

Line Of Business

Category Line of Business
ATTRACTIONS - RECREATION ABA
ATTRACTIONS - RECREATION AMUSEMENT PLACES
ATTRACTIONS - RECREATION ART AND MUSEUMS
ATTRACTIONS - RECREATION BARS - CLUBS
ATTRACTIONS - RECREATION BOATING
ATTRACTIONS - RECREATION DANCE AND THEATER
ATTRACTIONS - RECREATION GOLF
ATTRACTIONS - RECREATION HEALTH CLUBS AND SPA
ATTRACTIONS - RECREATION HUNTING AND FISHING
ATTRACTIONS - RECREATION LIVE MUSIC
ATTRACTIONS - RECREATION MARTIAL ARTS INSTRUCTION
ATTRACTIONS - RECREATION MINOR LEAGUES
ATTRACTIONS - RECREATION MISC ATTRACTIONS
ATTRACTIONS - RECREATION MLB AL
ATTRACTIONS - RECREATION MLB NL
ATTRACTIONS - RECREATION MLS
ATTRACTIONS - RECREATION MOVIE AND GAME RENTALS
ATTRACTIONS - RECREATION MOVIE THEATERS
ATTRACTIONS - RECREATION NBA
ATTRACTIONS - RECREATION NFL AFC
ATTRACTIONS - RECREATION NFL NFC
ATTRACTIONS - RECREATION NHL EC
ATTRACTIONS - RECREATION NHL WC
ATTRACTIONS - RECREATION NLL
ATTRACTIONS - RECREATION OUTDOOR ACTIVITIES
ATTRACTIONS - RECREATION SPORTS AND RECREATION
ATTRACTIONS - RECREATION SPORTS CLUBS
ATTRACTIONS - RECREATION TOURIST ATTRACTIONS
ATTRACTIONS - RECREATION WATER ACTIVITIES
ATTRACTIONS - RECREATION WNBA
ATTRACTIONS - RECREATION ZOOS GARDENS AQUARIUMS
AUTOMOTIVE SERVICE AUTOMOTIVE SERVICE
AUTOMOTIVE SERVICE CAR WASHING
AUTOMOTIVE SERVICE TRANSPORTATION
BANKS - FINANCIAL ATM LOCATIONS
BANKS - FINANCIAL BANKS
BANKS - FINANCIAL CREDIT UNIONS
BANKS - FINANCIAL FINANCIAL SERVICES
BANKS - FINANCIAL MISC FINANCIAL
EATING – DRINKING BAKERIES AND DESSERTS
EATING – DRINKING BARS
EATING – DRINKING BARS - CLUBS
EATING – DRINKING CLOTHING AND ACCESSORIES
EATING – DRINKING COFFEE SHOPS
EATING – DRINKING FARMS
EATING – DRINKING FOOD SERVICES
EATING – DRINKING GROCERY STORES AND MARKETS
EATING – DRINKING HEALTH FOOD
EATING – DRINKING MISC EATERIES
EATING – DRINKING RESTAURANTS
EDUCATION CATHOLIC SCHOOL
EDUCATION COLLEGE/UNIVERSITY - 4 YEAR +
EDUCATION GRADUATE SCHOOL ONLY
EDUCATION JUNIOR COLLEGE
EDUCATION NATIVE AMERICAN SCHOOL
EDUCATION PRIVATE SCHOOL
EDUCATION PUBLIC SCHOOL
EDUCATION STUDENT HOUSING
EDUCATION VOCATIONAL
FARM - RANCH FARMS
FARM - RANCH ORCHARDS
GOVERNMENT - PUBLIC EMERGENCY SERVICES
GOVERNMENT - PUBLIC GOVERNMENT OFFICES
GOVERNMENT - PUBLIC LIBRARIES
GOVERNMENT - PUBLIC LIBRARIES - PUBLIC
GOVERNMENT - PUBLIC MISC SERVICES
GOVERNMENT - PUBLIC POST OFFICES
HEALTH CARE SERVICES CHIROPRACTORS
HEALTH CARE SERVICES CLINICS
HEALTH CARE SERVICES EMERGENCY SERVICES
HEALTH CARE SERVICES HOSPITALS
HEALTH CARE SERVICES LODGING
HEALTH CARE SERVICES MISC SERVICES
HEALTH CARE SERVICES PHYSICIANS AND SURGEONS
HOSPITALITY CAMPS AND CAMPGROUNDS
HOSPITALITY COMMUNITY ORGANIZATIONS
HOSPITALITY LODGING
ORGANIZATIONS – ASSOCIATIONS COMMUNITY ORGANIZATIONS
ORGANIZATIONS – ASSOCIATIONS MISC ASSOCIATIONS
ORGANIZATIONS – ASSOCIATIONS NON-PROFIT ORGANIZATIONS
ORGANIZATIONS – ASSOCIATIONS PLACE OF WORSHIP
ORGANIZATIONS – ASSOCIATIONS SPORTS CLUBS
PERSONAL SERVICES APPAREL
PERSONAL SERVICES CHILD CARE
PERSONAL SERVICES EYECARE
PERSONAL SERVICES GOVERNMENT OFFICES
PERSONAL SERVICES LAUNDRIES - CLEANERS
PERSONAL SERVICES MISC SERVICES
PERSONAL SERVICES MISC SHOPPING
PERSONAL SERVICES PHOTOGRAPHY
PERSONAL SERVICES SPAS - BEAUTY
PET SERVICES ANIMAL HOSPITALS
PET SERVICES PET SERVICES
PET SERVICES VETERINARIANS
SHOPPING ACCESSORIES
SHOPPING APPLIANCES AND ELECTRONICS
SHOPPING ART AND MUSEUMS
SHOPPING ARTS AND CRAFTS
SHOPPING BATHROOM FIXTURES AND ACCESSORIES
SHOPPING BEDDING
SHOPPING BEVERAGES
SHOPPING CLOTHING AND ACCESSORIES
SHOPPING COLLECTIBLES
SHOPPING DEPARTMENT STORES
SHOPPING DRAPERY AND CURTAIN FIXTURES
SHOPPING EYEWARE AND EYECARE
SHOPPING FACTORY OUTLETS
SHOPPING FLOOR AND CARPET
SHOPPING FURNITURE STORES
SHOPPING HOME AND GARDEN
SHOPPING HOUSEWARES AND FURNISHINGS
SHOPPING JEWELRY
SHOPPING LIGHTING
SHOPPING MISC SERVICES
SHOPPING MISC SHOPPING
SHOPPING MUSIC EQUPITMENT
SHOPPING MUSICAL INSTRUMENTS
SHOPPING OUTDOOR FURNITURE
SHOPPING PET SHOPS
SHOPPING PHARMACIES
SHOPPING RETAIL SHOPS AND MARKETS
SHOPPING SHOES - FOOTWEAR
SHOPPING SHOPPING CENTERS AND MALLS
SHOPPING SPORTING GOODS
SHOPPING UTILITIES AND SERVICES
SHOPPING WEDDINGS
TRAVEL AIR TRAVEL
TRAVEL AIRPORTS
TRAVEL TAXI AND LIMO SERVICE
TRAVEL TOURIST INFORMATION
TRAVEL TRANSPORTATION
TRAVEL TRAVEL SERVICES


Community API

Overview

The Community API allows you to access in-depth Community demographic information at multiple geographic levels. Demographic information can be used with other content to create a dynamic search experience for your users.

Data Sources

The data provided in the Community API is aggregated from a variety of public and private sources including:

The U.S. Census and other government agencies. USGS, EPA, FBI and local crime agencies. American Community Survey, Bureau of Economic Analysis, Bureau of Labor Statistics, Bureau of Transportation Statistics, CDC, Department of Defense, Federal Aviation Administration,Federal Financial Institutions Examination Council, Federal Housing Finance, IRS, NCES, National Center for Health Statistics, National Parks Service, Social Security, USPS, Mediamark Consumer Survey, Applied Geographic Solutions, School Digger, and Niche.


Data Type
Update Frequency
Approx. Count
Multiple Sources (See Above)
Annually, Nationally
387 Fields

Interactive Docs




API Structure

The main endpoint for the Community API is:

https://search.onboard-apis.com/communityapi/v2.0.0/Resource/Package?{parameters}

Example

https://search.onboard-apis.com/communityapi/v2.0.0/Area/Full/?AreaId=CO44003

Headers

There are two required headers:

  1. Accept - set to either
    1. application/json
    2. application/xml
  2. APIKey - include the API Key assigned to you.

Resources

This API has one resource available for interacting with demographic information. The resource, Full, returns the values for over 380 different attributes and includes information on population, household, employment, income, crime, temperature, ethnicity and much more. A full list of the attributes as well as the description and display names can be found in the data dictionary.

Data is returned based on the specific geography in the request. All values are aggregated to the State, County, Census Place, County Subdivision, Zip Code or Neighborhood level.


What are the codes for each geography?

  • State (STxxx)
  • County (COxxx)
  • Zip Code (ZIxxx)
  • Census Place (PLxxx)
  • County Subdivision (CSxxx)
  • Maponics Neighborhood (NDxxx)
  • Maponics Residential Subdivision (RSxxx)
  • Maponics Metro (MTxxx)
  • Neighborhood (NHxxx) DEPRECATED

County Subdivision - States which use County Subdivision are: AK, CT, DC, ME, MA, NH, NJ, NY, RI and VT. All other states use Census Place.

Helpers

We also provide ‘Lookups’ that provide greater insight into the data.

Attribute Lookup This lookup can be used to get the names and description for the fields in the Full Resource.

Not sure of the geography ID? Check out the Area Hierarchy Lookup under the Area API. This lookup allows you to retrieve a list of associated geographies that a lat/long pair falls within. The results are returned in order from smallest to largest and can be used to pull back the appropriate aggregated community content.

Standard Response Information

A standard response from the Community API will include the following structure to help you handle different response codes and number of records. This can be found at the bottom of the response:

{

"xml_record": "1"

},

"status": {

"code": "0",

"long_description": "Your request was successfully processed.",

"short_description": "Success",

},

"xmlns": "https://www.ist_prod.obiwebservices.com/xmlns/community/1.0"

}

}

Status Codes

The following table highlights the expected status codes from the system. Beyond standard HTTP codes you will find custom status codes in the “Status” element of the response body.

1 Success Without Results Please check input values are valid
100 One or more input parameters are invalid or missing  

Data Dictionary

This data dictionary represents all of the fields currently available in the Community API.

Field Name Suggested Display Name Description
OB_IDNot Recommended to DisplayUniquely identifies each record.
GEO_TYPENot Recommended to DisplayIdentifies the geography level of the record: ZI = Zip Code
PL = Place
CS = County Subdivison
CO = County
ST = State
US = National
NH = Neighborhood
SB = School
DB = School District
SZ = Max Extent
*Note: Only those geography levels you have licensed will appear in the data.
OB_GEO_IDNot Recommended to DisplayUniquely identifies each record by combining the GEO_TYPE and GEO_CODE values.
GEO_CODENot Recommended to DisplayNumeric identify for the geography. Often the federal identification code, but may be a unique value assigned by OBI. This value is unique by GEO_TYPE (but not across GEO_TYPEs).
GEO_NAMEStandard non Onboard specific geography name.
COUNTY3Not Recommended to DisplayThree digit county FIPS code. May be used for matching to other data sets.
COUNTY5Not Recommended to DisplayThe FIPS County Number.
COUNTYNAMECountyCounty name
STATENot Recommended to DisplayThe FIPS State Number *Note: Value "00" = National average or value.
STATENAMEStateState name *Note: Is null for national records (STATE = "00").
LATITUDENot Recommended to DisplayCentroid latitude for the area.
LONGITUDENot Recommended to DisplayCentroid longitude for the area.
MARKET_IDNot Recommended to DisplayThe unique identifier for the associated market. A market is usually similar in scope to a metropolitan area. Only supported in Neighborhood aggregation file.
MARKET_NAMEThe name of the market that the hood is associated with. Only supported in Neighborhood aggregation file.
AGE00_04Population age 0-4Number of people living within the area between 0 and 4 years of age.
AGE05_09Population age 5-9Number of people living within the area between 5 and 9 years of age.
AGE10_14Population age 10-14Number of people living within the area between 10 and 14 years of age.
AGE15_19Population age 15-19Number of people living within the area between 15 and 19 years of age.
AGE20_24Population age 20-24Number of people living within the area between 20 and 24 years of age.
AGE25_29Population age 25-29Number of people living within the area between 25 and 29 years of age.
AGE30_34Population age 30-34Number of people living within the area between 30 and 34 years of age.
AGE35_39Population age 35-39Number of people living within the area between 35 and 39 years of age.
AGE40_44Population age 40-44Number of people living within the area between 40 and 44 years of age.
AGE45_49Population age 45-49Number of people living within the area between 45 and 49 years of age.
AGE50_54Population age 50-54Number of people living within the area between 50 and 54 years of age.
AGE55_59Population age 55-59Number of people living within the area between 55 and 59 years of age.
AGE60_64Population age 60-64Number of people living within the area between 60 and 64 years of age.
AGE65_69Population age 65-69Number of people living within the area between 65 and 69 years of age.
AGE70_74Population age 70-74Number of people living within the area between 70 and 74 years of age.
AGE75_79Population age 75-79Number of people living within the area between 75 and 79 years of age.
AGE80_84Population age 80-84Number of people living within the area between 80 and 84 years of age.
AGEGT85Population age 85+Number of people living within the area over 85 years of age.
MEDIANAGEMedian AgeHalf of the total population is above the listed age, half is below it.
MEDIANAGEPY_5Median Age - 5 year forecastMedian population age, 5 year forecast.
MEDIANAGEPY_10Median Age - 10 year forecastMedian population age, 10 year forecast.
AGEAVEPY_5Average Age - 5 year forecastProjected average age of people living in the area; 5 year forecast.
AGEAVEPY_10Average Age - 10 year forecastProjected average age of people living in the area; 10 year forecast.
ANCESTAMERAncestry AmericanNumber of people living within the area of American descent.
ANCESTAMINDAncestry American IndianNumber of people living within the area of Native American descent.
ANCESTASIANAncestry AsianNumber of people living within the area of Asian descent.
ANCESTEUROAncestry EuropeanNumber of people living within the area of European descent.
ANCESTHAWAIAncestry HawaiianNumber of people living within the area of Hawaiian descent.
ANCESTHISPAncestry HispanicNumber of people living within the area of Hispanic descent.
ANCESTOTHERAncestry OtherNumber of people living within the area of a descent listed as Other.
ANCESTUNCLASSIFEDAncestry UnclassifiedNumber of people living within the area of an unclassified descent.
LANGASIANSpeak Asian at homeNumber of households in the area who speak Asian and Pacific Island languages.
Note: Language may not match roll up from ST to US level due to rounding that occurs during aggregation.
LANGENGSpeak English at homeNumber of households in the area who speak only English.
LANGEUROSpeak European Language at homeNumber of households in the area who speak other European languages.
LANGOTHERSpeak Other Language at homeNumber of households in the area who speak all other languages.
LANGSPANSpeak Spanish at homeNumber of households in the area who speak Spanish.
LANGTOTALLanguages: TotalTotal population by language spoken
RACEWHITERace: WhiteNumber of people living within the area whose race is White.
RACEAMERINDRace: American Indian, Eskimo, AleutNumber of people living within the area whose race is American Indian, Eskimo, or Aleut.
RACEASIANRace: AsianNumber of people living within the area whose race is Asian.
RACEBLACKRace: BlackNumber of people living within the area whose race is Black.
RACEHAWAIRace: Hawaiian or Pacific IslanderNumber of people living within the area whose race is Hawaiian/Pacific Islander.
RACEMULTIRace: Multiple TypesNumber of people living within the area whose race is of multiple types.
RACEOTHERRace: OtherNumber of people living within the area whose race is listed as Other.
RACEHISPPopulation: HispanicNumber of people living within the area who are of Hispanic origin.
RACENONHISPPopulation: Not HispanicNumber of people living within the area who are of a Non-Hispanic origin.
RACETOTALPOPRace: TotalTotal population by race.
RACEWHITEPY_5Race 5 year forecast: WhiteProjected number of people living within the area, whose race is White, 5 year forecast.
RACEASIANPY_5Race 5 year forecast: AsianProjected number of people living within the area whose race is Asian, 5 year forecast
RACEBLACKPY_5Race 5 year forecast: BlackProjected number of people living within the area whose race is Black, 5 year forecast.
RACEHISPPY_5Race 5 year forecast: HispanicProjected number of people living within the area in whose race is Hispanic, 5 year forecast.
RACEOTHERPY_5Race 5 year forecast: OtherProjected number of people living within the area whose race is listed as Other, 5 year forecast.
MARMARRNow MarriedNumber of people living in the area who are currently married.
MARDIVORDivorcedNumber of people living in the area who are currently divorced.
MARNEVERNever MarriedNumber of people living in the area who have never been married.
MARSEPSeparatedNumber of people living in the area that are married but separated.
MARWIDOWWidowedNumber of people living in the area who are widowed.
MARTOTALPOPTotal population by marriage status.
HHDHouseholdsNumber of households in the area. A household is a person or group of people who occupy a housing unit.
HHDAVESZAverage Household SizeAverage size of area households in number of people
HHDCHHouseholds: With ChildrenNumber of households with one or more children.
HHDFAMHouseholds: FamilyNumber of family households in the area. A family household consists of a householder and one or more other persons living in the same household who are related to the householder by birth, marriage or adoption.
HHDNCHHouseholds: With No ChildrenNumber of households with no children.
HHDNFMHouseholds: Non-FamilyA householder who shares the home with nonrelatives only; for example, with roommates or an unmarried partner.
HHDSINGLEHouseholds: One PersonA householder who makes provision for his or her own food or other essentials for living without combining with any other person.
FAMAVESZAverage Family SizeAverage family size for people living in the area.
HHDHIGHPY_5Households - 5 year forecast: High rangeProjected number of households in the area, high range, 5 year forecast
HHDLOWPY_5Households - 5 year forecast: Low rangeProjected number of households in the area, low range, 5 year forecast
HHDPY_5Households - 5 year forecastProjected number of households in the area, 5 year forecast
HHDPY_10Households - 10 year forecastProjected number of households in the area, 10 year forecast
HHPOPPY_5Population in Households - 5 year forecastProjected number of people living in households, 5 year forecast.
HHPOPPY_10Population in Households - 10 year forecastProjected number of people living in households, 10 year forecast.
HHPPY_5Persons per Household - 5 year forecastProjected number of people per household, 5 year forecast.
HHPPY_10Persons per Household - 10 year forecastProjected number of people per household, 10 year forecast.
AIMCYLT_25Median Household Income - Householder Age Under 25Half the people in the area under 25 years old earn less than this dollar amount, half earn more than this amount.
AIMCY25_44Median Household Income - Householder Age 25-44Half the people in the area between the ages of 25 and 44 earn less than this dollar amount, half earn more than this amount.
AIMCY45_64Median Household Income - Householder Age 45-64Half the people in the area between the ages of 45 and 64 earn less than this dollar amount, half earn more than this amount.
AIMCYGT_65Median Household Income - Householder Age Over 65Half the people in the area over the age of 65 earn less than this dollar amount, half earn more than this amount.
HINCY00_10Household Income $0-$10,000Number of households in the area with income between $0 and $10,000.
HINCY10_15Household Income $10,000-$15,000Number of households in the area with income between $10,000 and $15,000.
HINCY15_20Household Income $15,000-$20,000Number of households in the area with income between $15,000 and $20,000.
HINCY20_25Household Income $20,000-$25,000Number of households in the area with income between $20,000 and $25,000.
HINCY25_30Household Income $25,000-$30,000Number of households in the area with income between $25,000 and $30,000.
HINCY30_35Household Income $30,000-$35,000Number of households in the area with income between $30,000 and $35,000.
HINCY35_40Household Income $35,000-$40,000Number of households in the area with income between $35,000 and $40,000.
HINCY40_45Household Income $40,000-$45,000Number of households in the area with income between $40,000 and $45,000.
HINCY45_50Household Income $45,000-$50,000Number of households in the area with income between $45,000 and $50,000.
HINCY50_60Household Income $50,000-$60,000Number of households in the area with income between $50,000 and $60,000.
HINCY60_75Household Income $60,000-$75,000Number of households in the area with income between $60,000 and $75,000.
HINCY75_100Household Income $75,000-$100,000Number of households in the area with income between $75,000 and $100,000.
HINCY100_125Household Income $100,000-$125,000Number of households in the area with income between $100,000 and $125,000.
HINCY125_150Household Income $125,000-$150,000Number of households in the area with income between $125,000 and $150,000.
HINCY150_200Household Income $150,000-$200,000Number of households in the area with income between $150,000 and $200,000.
HINCY200_250Household Income $200,000-$250,000Number of households in the area with income between $200,000 and $250,000.
HINCY250_500Household Income $250,000-$500,000Number of households in the area with income between $250,000 and $500,000.
HINCYGT_500Household Income $500,000+Number of households in the area with income above $500,000.
INCCYAVEHHAverage Household IncomeAverage income of households in the area.
INCCYMEDDMedian household incomeHalf of the households have an income above the amount listed, half have an income below it.
INCCYMEDDHMedian Disposable Household IncomeHalf the households have disposable income above the amount listed; half have disposable income below it.
INCAVEHHPY_5Average Household Income - 5 year forecastProjected average household income, 5 year forecast.
INCCYPCAPPer capita incomeAverage individual income of people in the area.
INCDIFFBASECY% Change in Average Household Income since 2000Change in the dollar value of average household income, expressed as a percentage increase or decrease since 2000 If null, then there was no reliable 2000 value to compare against.
INCDIFFCURRCY% Change in Average Household Income since 2010Change in the dollar value of average household income, expressed as a percentage increase or decrease since 2010.
INCMEDPY_5Median Household Income - 5 year forecastProjected median household income, 5 year forecast.
SALAVECYAverage Employee SalaryThe average employee salary for people in the area.
SALMEDCYMedian Employee SalaryMedian employee salary for people in this area.
HHNWCYLT_0Households by Wealth: $0 and under Net WorthDEPRECATED. Number of households with a net worth less than $1
HHNWCY1_5ouseholds by Wealth: $1 to $4,999 Net WorthDEPRECATED. Number of households with a net worth between $1 - $4,999
HHNWCY5_10Households by Wealth: $5,000 to $9,999 Net WorthDEPRECATED. Number of households with a net worth between $5,000 - $9,999
HHNWCY10_25Households by Wealth: $10,000 to $24,999 Net WorthDEPRECATED. Number of households with a net worth between $10,000 - $24,999
HHNWCY25_50Households by Wealth: $25,000 to $49,999 Net WorthDEPRECATED. Number of households with a net worth between $25,000 - $49,999
HHNWCY50_100Households by Wealth: $50,000 to $99,999 Net WorthDEPRECATED. Number of households with a net worth between $50,000 - $99,999
HHNWCY100_250Households by Wealth: $100,000 to $249,999 Net WorthDEPRECATED. Number of households with a net worth between $100,000 - $249,999
HHNWCY250_500Households by Wealth: $250,000 to $499,999 Net WorthDEPRECATED. Number of households with a net worth between $250,000 - $499,999
HHNWCYGT_500Households by Wealth: $500,000 Net WorthDEPRECATED. Number of households with a net worth greater than $500,000
HHNWMEANCYAverage Household Net WorthDEPRECATED. The average household net worth for this area.
HHNWMEDCYMedian Household Net WorthDEPRECATED. The median household net worth for this area.
EDULTGR9Education: Less than 9th GradeNumber of people who achieved an 8th grade education.
EDUSHSCHEducation: Some High SchoolNumber of people who achieved some high school education.
EDUHSCHEducation: High School GraduateNumber of people who are high school graduates.
EDUSCOLLEducation: Some CollegeNumber of people who achieved some college education.
EDUASSOCEducation: Associate DegreeNumber of people who achieved an Associate’s Degree.
EDUINDEXEducational Climate Index This measure of socioeconomic status is based on the U.S. Census Bureau’s Socioeconomic Status (SES) measure with weights adjusted to more strongly reflect the educational aspect of social status (education 2:1 to income & occupation). Factors in this measure are income, educational achievement and occupation of persons within the ZIP code. Since this measure is based on the population of an entire ZIP code, it may not reflect the nature of an individual school.
EDUBACHEducation: Bachelor's DegreeNumber of people who achieved a Bachelor’s Degree.
EDUGRADEducation: Graduate DegreeNumber of people who achieved a Graduate Degree.
EDUTOTALPOPEducation: TotalTotal population by education.
OCCARTSEmployee Count: Arts, design, entertainment, sports, and media occupationsThe number of people living in this area employed in arts, design, entertainment, sports and media.
OCCBFINEmployee Count: Business and financial operations occupationsThe number of people living in this area employed in business and financial operations.
OCCBGMTEmployee Count: Building and grounds cleaning and maintenance occupationsThe number of people living in this area employed in building and grounds maintenance.
OCCCLEROEmployee Count: Administrative SupportThe number of people living in this area employed as administrative support.
OCCCOMPEmployee Count: Computer and mathematical science occupationsThe number of people living in this area employed in computer and mathematical occupations.
OCCCONSEmployee Count: Construction and extraction occupationsThe number of people living in this area employed in construction and extraction occupations.
OCCCSRVEmployee Count: Community and social services occupationsThe number of people living in this area employed in community and social service occupations.
OCCEDUCEmployee Count: Education, training, and library occupationsThe number of people living in this area employed in education, training, and library occupations.
OCCENGREmployee Count: Architecture and engineering occupationsThe number of people living in this area employed in architecture and engineering.
OCCFOODEmployee Count: Food preparation and serving related occupationsThe number of people living in this area employed in food preparation and serving.
OCCHCSOEmployee Count: Healthcare support occupationsThe number of people living in this area employed in healthcare support occupations.
OCCHCSPEmployee Count: Healthcare practitioners and technical occupationsThe number of people living in this area employed as healthcare practitioners and in technical occupations.
OCCINSTALEmployee Count: Installation, maintenance, and repair occupationsThe number of people living in this area employed in installation, maintenance and repair occupations.
OCCLEGALEmployee Count: Legal OccupationsThe number of people living in this area employed in legal occupations.
OCCMILTEmployee Count: Military The number of people living in this area employed in military occupations.
OCCPCAREmployee Count: Personal care and service occupationsThe number of people living in this area employed in personal care and service occupations.
OCCPRIMEmployee Count: Farming, Forestry and FishingThe number of people living in this area employed in farming, forestry, and fishing.
OCCPRODEmployee Count: Production occupationsThe number of people living in this area employed as production workers.
OCCPROTEmployee Count: Protective ServicesThe number of people living in this area employed in protective services.
OCCSALPREmployee Count: Sales ProfessionalsThe number of people living in this area employed as sales professionals.
OCCSCNSEmployee Count: Life, physical, and social science occupationsThe number of people living in this area employed in life, physical and social science occupations.
OCCTRANEmployee Count: Transportation occupationsThe number of people living in this area employed in transportation occupations.
OCCYEXECEmployee Count: Executives, Managers, AdministratorsThe number of people living in this area employed as executives, managers and administrators.
OCCUNCLUnlcassified EmployeesThe number of people living in this area employed in unclassified occupations.
OCCBLUCOOccupations: Blue CollarBlue collar occupations include: farming, forestry and fishing; handlers, equipment cleaners, helpers and laborers; machine operators, assemblers and inspectors; precision production, craft and repair; private household services; protective services; services other than protective and household; and transportation and material moving. ** Note: OCCUNCL and OCCMILT are excluded from the bue collar calculation.
OCCWHTCOOccupations: White CollarWhite collar workers are traditionally defined as office workers. White collar occupations include: administrative and clerical support; executive, administrative and managerial; professional specialties; sales; and technicians and related support. ** Note: OCCUNCL and OCCMILT are excluded from the white collar calculation.
OCCTOTPOPAll EmployeesTotal population by occupation.
EXPAPPARApparelThe costs associated with women’s, men’s, boys and girls clothing, jewelry, footwear, dry cleaning, material for sewing clothing, patterns, etc. Index score (100=National Average)
EXPCONTRIBContributionsThe costs associated with cash contributions to charities, churches, child support, political organizations and other cash gifts. Index score (100=National Average)
EXPEDUCEducationThe costs associated with books, supplies, college, high school, elementary school and preschool tuition. Index score (100=National Average)
EXPENTEntertainmentThe costs associated with fees and admissions to clubs, movies and sporting events, cable tv and satellite services, musical instruments, video and audio equipment rental, sports, recreation and exercise equipment, toys, hobbies, playground equipment and pet supplies. Index score (100=National Average)
EXPFOODBEVFood And BeveragesThe costs associated with food at home, food away from home; restaurants, catered affairs, non-alcoholic and alcoholic beverages. Index score (100=National Average)
EXPGIFTGiftsThe costs associated with gifts of apparel, gifts of apparel accessories, gifts of education, gifts of recreation, gifts of food and beverages, gifts of household furnishings and equipment, gifts of transportation, gifts of cash, etc. Index score (100=National Average)
EXPHEALTHHealth CareThe costs associated with health care including: health insurance, medicare payments, medical services, prescription and non prescription drugs and medical supplies. Index score (100=National Average)
EXPHHShelterThe costs associated with owned dwellings; maintenance, repairs, homeowners insurance, property management and security. Index score (100=National Average)
EXPHHFURNHousehold Furnishings And EquipmentThe costs associated with household textiles, furniture, floor coverings, major appliances, small appliances and housewares. Index score (100=National Average)
EXPHHOPSHousehold OperationsThe costs associated with household operations; in home babysitting and child care, day care, nursery and preschools. Also includes other household expenses like: housekeeping services and supplies, lawn care services, home security, pest control, appliance repair and rental as well as other household products and postage. Index score (100=National Average)
EXPINSURPersonal InsuranceThe costs associated with life, endowment, annuity and other nonhealth insurance. Index score (100=National Average)
EXPMISCMiscellaneous ExpensesThe costs associated with miscellaneous purchases; lotteries, legal fees, funeral expenses, dating services, bank service charges, credit card and shopping club memberships. Index score (100=National Average)
EXPPERSPersonal CareThe costs associated with personal care products and services including; hair care, oral hygiene products and cosmetics. Index score (100=National Average)
EXPREADReadingThe costs associated with magazine and newspaper subscriptions and non-subscriptions and books. Index score (100=National Average)
EXPTOBTobaccoThe costs associated with cigarettes, tobacco products and smoking accessories. Index score (100=National Average)
EXPTRANSPORTTransportationThe costs associated with new and used vehicle purchases, vehicle finance charges, gasoline and oil, vehicle repair and maintenance, vehicle insurance, parking and tolls, public transportation and other transportation costs. Index score (100=National Average)
EXPUTILUtilitiesThe costs associated with utilities, fuels and public services including; natural gas, electricity, fuel oil, telephone services, water and sewerage, trash and garbage collection and septic tank cleaning. Index score (100=National Average)
EXPTOTALAverage Total Household ExpenditureAverage annual expenditures for food, beverages, housing, utilities, household operations, household supplies and furnishings, apparel, transportation, health care, entertainment, personal care, personal insurance, education and miscellaneous. (100=National Average)
IDXEXPTOTALTotal Household ExpenditureThe average of the total expenses shown within an area per household as it relates to the national average. Index score (100=National Average)
TRW0_5Workers by Travel Time to Work: Less than 5 minutesThe number of workers in the area with a commute time less than 5 minutes.
TRW5_10Workers by Travel Time to Work: 5 to 10 minutesThe number of workers in the area with a commute time between 5 and 10 minutes.
TRW10_15Workers by Travel Time to Work: 10 to 15 minutesThe number of workers in the area with a commute time between 10 and 15 minutes.
TRW15_20Workers by Travel Time to Work: 15 to 20 minutesThe number of workers in the area with a commute time between 15 and 20 minutes.
TRW20_30Workers by Travel Time to Work: 20 to 30 minutesThe number of workers in the area with a commute time between 20 and 30 minutes.
TRW30_45Workers by Travel Time to Work: 30 to 45 minutesThe number of workers in the area with a commute time between 30 and 45 minutes.
TRW45_60Workers by Travel Time to Work: 45 to 60 minutesThe number of workers in the area with a commute time between 45 and 60 minutes.
TRWGT_60Workers by Travel Time to Work: Greater than 60 minutesThe number of workers in the area with a commute time greater than 60 minutes.
TRWAVEAverage Travel Time to WorkThe average commute time of workers living in this area.
TRWBYCTransportation to Work: BicycleThe number of workers living in the area who commute by bicycle.
TRWCPOOLTransportation to Work: CarpoolThe number of workers living in the area who commute by carpool.
TRWDRIVETransportation to Work: Solo DriversThe number of workers living in the area who commute as solo drivers.
TRWHOMETransportation to Work: Work at Home The number of workers living in the area who work from home.
TRWMOTOTransportation to Work: MotorcycleThe number of workers living in the area who commute by motorcycle.
TRWOTHERTransportation to Work: Other MeansThe number of workers living in the area who commute by other means.
TRWPUBLICTransportation to Work: PublicThe number of workers living in the area who commute by train, subway, ferry, bus or taxi.
TRWSELFTransportation to Work: Walk The number of workers living in the area who commute by walking.
VPH1Households with one vehicle availablePercent of households with one vehicle available regularly.
VPHGT1Households with two or more vehicles availablePercent of households with two or more vehicles available regularly.
VPHNONEHouseholds with no vehicles availablePercent of households with no vehicle available regularly.
POPCYPopulationNumber of people living within the area.
POPFEMALEFemale PopulationNumber of females living within the area.
POPMALEMale PopulationNumber of males living within the area.
POPDNSTYPopulation DensityPersons per square mile.
POPDIFFBASECY% Change in Population Since 2000Change in population since 2000 expressed as a percentage increase or decrease. If the field is null, then there was no reliable 2000 value to compare against.
POPDIFFCURRCY% Change in Population Since 2010Change in population since 2010 expressed as a percentage increase or decrease. If the field is null, then there was no reliable 2010 value to compare against.
POPCYGQCOLLGroup Quarters Population - CollegeNumber of people within the area living in college residence halls.
POPCYGQMILGroup Quarters Population - MilitaryNumber of people within the area living in military barracks.
POPPY_5Population - 5 year forecastProjected population,5 year forecast.
POPPY_10Population - 10 year forecastProjected population,10 year forecast.
POPLOWPY_5Population - 5 year forecast: Low rangeProjected population, low range, 5 year forecast.
POPHIGHPY_5Population - 5 year forecast: High rangeProjected population, high range, 5 year forecast.
POPFEMALEPY_5Female Population - 5 year forecastProjected female population, 5 year forecast.
POPFEMALEPY_10Female Population - 10 year forecastProjected female population, 10 year forecast.
POPMALEPY_5Male Population - 5 year forecastProjected male population, 10 year forecast.
POPMALEPY_10Male Population - 10 year forecastProjected male population, 10 year forecast.
POPGQPY_5Group Quarters Population - 5 year forecastProjected number of people living in group quarters (institutional and non-institutional), 5 year forecast.
POPGQPY_10Group Quarters Population - 10 year forecastProjected number of people living in group quarters (institutional and non-institutional), 10 year forecast.
DAYPOPDaytime PopulationThe daytime population in this area.
SEASONPOPSeasonal PopulationSeasonal population for this area.
HOUMEDAGEDwellings Median AgeHalf the dwellings in the area are older than this, half are newer.
DWLOWNEDOwner-Occupied DwellingsNumber of owner-occupied dwellings in the area.
DWLRENTRenter-Occupied DwellingsNumber of renter-occupied dwellings in the area.
DWLVACNTVacant DwellingsNumber of vacant dwellings in the area.
DWLTOTALTotal DwellingsTotal dwellings in the area.
LORTURNAnnual Residential TurnoverPercentage of households in the area where the primary householder changed in the past year.
EMPADMINEmployees: Administrative and Support and Waste Management and Remediation ServicesFull-time equivalent (FTE) employees working in this area in administrative and support and waste management and remediation services.
EMPAGRICEmployees: Agricultural, Forestry, FishingFull-time equivalent (FTE) employees working in this area employed in agricultural, forestry, and fishing.
EMPARTSEmployees: Arts, Entertainment, and RecreationFull-time equivalent (FTE) employees working in this area employed in arts, entertainment and recreation.
EMPCONSTEmployees: ConstructionFull-time equivalent (FTE) employees working in this area employed in construction.
EMPEDUEmployees: Educational ServicesFull-time equivalent (FTE) employees working in this area employed in educational services.
EMPEXECEmployees: Management of Companies and EnterprisesFull-time equivalent (FTE) employees working in this area employed in management of companies and enterprises
EMPFIREEmployees: Finance, Insurance and Real EstateFull-time equivalent (FTE) employees working in this area employed in finance, insurance, and real estate.
EMPFOODEmployees: Accommodation and Food ServicesFull-time equivalent (FTE) employees working in this area employed in accommodation and food services.
EMPHCSPEmployees: Health Care and Social AssistanceFull-time equivalent (FTE) employees working in this area employed in health care and social assistance.
EMPHOMEEmployees: Work at HomeFull-time equivalent (FTE) employees in this area who work from home.
EMPINFOEmployees: InformationFull-time equivalent (FTE) employees working in this area employed in information services.
EMPMANUFEmployees: ManufacturingFull-time equivalent (FTE) employees working in this area employed in manufacturing.
EMPMILEmployees: MilitaryFull-time equivalent (FTE) employees working in this area employed by the U.S. Government.
EMPMINEEmployees: MiningFull-time equivalent (FTE) employees working in this area employed in mining.
EMPPROFEmployees: Professional, Scientific, and Technical ServicesFull-time equivalent (FTE) employees working in this area employed in professional, scientific and technical services.
EMPPUBADEmployees: Public AdministrationFull-time equivalent (FTE) employees working in this area employed in public administration.
EMPREEmployees: Real Estate and Rental and LeasingFull-time equivalent (FTE) employees working in this area employed in real estate, rental and leasing.
EMPRTRADEmployees: Retail TradeFull-time equivalent (FTE) employees working in this area employed in retail trade.
EMPSRVEmployees: ServicesFull-time equivalent (FTE) employees working in this area employed in the services industry.
EMPTRANSEmployees: Transportation and CommunicationsFull-time equivalent (FTE) employees working in this area employed in transportation and communications.
EMPUTLEmployees: UtilitiesFull-time equivalent (FTE) employees working in this area employed in utilities.
EMPUNCLAEmployees: UnclassifiedThe number of people working in this area with employment listed as unclassified.
EMPUNEMPEmployees: UnemployedThe number of people in this area who are unemployed.
EMPWTRADEmployees: Wholesale TradeFull-time equivalent (FTE) employees working in this area employed in wholesale trade.
EMPTOTALEmployees: TotalTotal Full-time equivalent (FTE) employees working in the area.
COCRMCYASSTAssault Risk (County)Only included for ZI, PL, CS, and TR level records: The act of unlawfully threatening or attempting to injure another. Index score (100=National Average)
COCRMCYBURGBurglary Risk (County)Only included for ZI, PL, CS, and TR level records: The act of entering a building or other premises with the intent to commit theft. Index score (100=National Average)
COCRMCYLARCLarceny Risk (County)Only included for ZI, PL, CS, and TR level records: The unlawful taking and removing of another's personal property with the intent of permanently depriving the owner. Index score (100=National Average)
COCRMCYMURDMurder Risk (County)Only included for ZI, PL, CS, and TR level records: Intentionally causing the death of another person without extreme provocation or legal justification. Index score (100=National Average)
COCRMCYMVEHMotor Vehicle Theft Risk (County)Only included for ZI, PL, CS, and TR level records: Theft or attempted theft of a motor vehicle. Index score (100=National Average)
COCRMCYPERCPersonal Crime Risk (County)Only included for ZI, PL, CS, and TR level records: Combined risks of rape, sexual assault, personal robbery, assault, purse snatching and pocket picking. Index score (100=National Average)
COCRMCYPROCProperty Crime Risk (County)Only included for ZI, PL, CS, and TR level records: Combined risks of burglary, motor vehicle theft, or theft. Index score (100=National Average)
COCRMCYRAPERape Risk (County)Only included for ZI, PL, CS, and TR level records: Forced sexual intercourse. Index score (100=National Average)
COCRMCYROBBRobbery Risk (County)Only included for ZI, PL, CS, and TR level records: The act of unlawfully taking the property of another by the use of violence or intimidation. Index score (100=National Average)
COCRMCYTOTCTotal Crime Risk (County)Only included for ZI, PL, CS and TR level records: A score that represents the combined risks of rape, murder, assault, robbery, burglary, larceny and vehicle theft compared to the national average of 100. A score of 200 indicates twice the national average total crime risk, while 50 indicates half the national risk. The different types of crime are given equal weight in this score.
CRMCYASSTAssault RiskThe act of unlawfully threatening or attempting to injure another. Index score (100=National Average)
CRMCYBURGBurglary RiskThe act of entering a building or other premises with the intent to commit theft. Index score (100=National Average)
CRMCYLARCLarceny RiskThe unlawful taking and removing of another’s personal property with the intent of permanently depriving the owner. Index score (100=National Average)
CRMCYMURDMurder RiskIntentionally causing the death of another person without extreme provocation or legal justification. Index score (100=National Average)
CRMCYMVEHMotor Vehicle Theft RiskTheft or attempted theft of a motor vehicle. Index score (100=National Average)
CRMCYPERCPersonal Crime RiskCombined risks of rape, sexual assault, personal robbery, assault, purse snatching and pocket picking. Index score (100=National Average)
CRMCYPROCProperty Crime RiskCombined risks of burglary, motor vehicle theft, or theft. Index score (100=National Average)
CRMCYRAPERape RiskForced sexual intercourse. Index score (100=National Average)
CRMCYROBBRobbery RiskThe act of unlawfully taking the property of another by the use of violence or intimidation. Index score (100=National Average)
CRMCYTOTCTotal Crime RiskA score that represents the combined risks of rape, murder, assault, robbery, burglary, larceny and vehicle theft compared to the national average of 100. A score of 200 indicates twice the national average total crime risk, while 50 indicates half the national risk. The different types of crime are given equal weight in this score.
PRECIPANNAnnual Total PrecipitationCombined average annual rainfall and snowfall in inches.
TMPAVEJANAverage January TemperatureAverage temperature (degrees Fahrenheit) in January.
TMPAVEJULAverage July TemperatureAverage temperature (degrees Fahrenheit) in July.
TMPMAXJANAverage January High TemperatureAverage maximum temperature (degrees Fahrenheit) in January.
TMPMAXJULAverage July High TemperatureAverage maximum temperature (degrees Fahrenheit) in July.
TMPMINJANAverage January Low TemperatureAverage minimum temperature (degrees Fahrenheit) in January.
TMPMINJULAverage July Low TemperatureAverage minimum temperature (degrees Fahrenheit) in July.
RSKCYQUAKEarthquake RiskThe total earthquake risk. Based on analysis of historical earthquake magnitudes and fault locations. Index score (100=National Average)
RSKCYRISKWeather RiskThe total risk from various storm types (hurricanes, tornadoes, damaging hailstorms and damaging wind storms). Index score (100=National Average)
RSKCYHANXHail IndexThe total risk of damaging hailstorms. Based on analysis of historical hail frequency and severity. Index score (100=National Average)
RSKCYHUNXHurricane IndexThe total hurricane risk. Based on analysis of historical hurricane tracks and intensity. Index score (100=National Average)
RSKCYTONXTornado IndexThe total tornado risk. Based on analysis of historical tornado tracks and intensity. (100=National Average)
RSKCYWINXWind Index The total risk of severe winds. Based on analysis of the frequency and severity of historical damaging windstorms, typically associated with thunderstorms. Index score (100=National Average)
AIRXAir Pollution IndexA score that represents the relative air quality by combining indices of Ozone, Carbon Monoxide, Lead, Nitrogen Oxide, and Particulate matter and comparing to the national average of 100. A score of 200 indicates twice the presence of air pollutants than the national average, while 50 indicates half the presence. The different types of pollution are given equal weight in this score.
OZONEOzone IndexAn invisible gas that irritates and impairs breathing. Index score (100=National Average).
CARBMONOCarbon Monoxide IndexA colorless, odorless, highly poisonous gas formed by the incomplete combustion of carbon or a carbonaceous material, such as gasoline. Index score (100=National Average)
LEADLead IndexA metallic element used in products like solder and paint. Lead's presence in the air may be particularly harmful to the health of infants and children. Index score (100=National Average)
NO2NO2 IndexPoisonous brown gases, often found in auto exhaust fumes. It is a primary contributor to smog. Index score (100=National Average)
PM10Particulate Matter IndexFine particles of pollutants which tend to reduce visibility and invade the lungs deeply. Index score (100=National Average)
AIRPORTClosest Major Airport Closest airport with more than 10,000 boardings annually (as of March 2013).
AIRPORTDISTDistance Distance to closest airport with more than 10,000 boardings annually. Calculated from the geographic centroid of the Census Zip Area (CZA).
CITY500_CLOSEST_NAMEClosest Major CityClosest major city with a population of greater than 500,000.
JCClosest two-year Public CollegeClosest accredited 2-year public college.
JCDISTDistance to closest two-year Public CollegeDistance to closest 2-year public college. Calculated from the geographic centroid of the Census Zip Area (CZA).
FOURYRClosest four-year Public CollegeClosest accredited 4-year public college.
FOURYRDISTDistance to closest four-year Public CollegeDistance to closest 4-year public college. Calculated from the geographic centroid of the Census Zip Area (CZA).
TEAMClosest Major Sports TeamClosest sports team. Leagues included are:
The National Football League,
The National Basketball Association,
The National Hockey League,
The Women’s National Basketball Association and
Major League Baseball and Minor League Baseball teams
TEAMDISTDistance to closest Major Sports TeamDistance to closest major sports team. Calculated from the geographic centroid of the Census Zip Area (CZA).
AVG_PROP_TAXAverage Property TaxAverage property tax amount for the area.
AVG_PROP_TAX_YEARNot Recommended to DisplayYear used in determining average property tax.
AVG_PROP_TAX_YEAR_COUNTNot Recommended to DisplayNumber of properties used in determining average property tax.
SALESTAXRATESales Tax RateThe reported sales tax rate for the area. Additional local taxes may apply (see SALESTAXTYPE).
SALESTAXTYPENot Recommended to DisplayIndicates whether the sales tax rate is likely to include all local taxes.
PL = Place level sales tax
CO = County level sales tax (additional local taxes may apply)
ST = County or state level sales tax (additional local taxes may apply)
STUDIO_COUNTYGross Rent Estimate – Studio Apartment (County)Gross rent estimate for a studio apartment; includes the shelter rent plus the cost of all tenant-paid utilities, except telephones, cable or satellite television service, and internet service.
STUDIOINDEXGross Rent Index – Studio ApartmentLocalized index to show expected local pricing variations for studio apartments.
ONE_BED_COUNTYGross Rent Estimate – One-Bedroom Apartment (County)Gross rent estimate for a one bedroom apartment; includes the shelter rent plus the cost of all tenant-paid utilities, except telephones, cable or satellite television service, and internet service
ONE_BEDINDEXGross Rent Index – One-Bedroom ApartmentLocalized index to show expected local pricing variations for a one bedroom dwelling.
TWO_BED_COUNTYGross Rent Estimate – Two-Bedroom Apartment (County)Gross rent estimate for a two bedroom apartment; includes the shelter rent plus the cost of all tenant-paid utilities, except telephones, cable or satellite television service, and internet service.
TWO_BEDINDEXGross Rent Index – Two-Bedroom ApartmentLocalized index to show expected local pricing variations for a two bedroom dwelling.
THREE_BED_COUNTYGross Rent Estimate – Three-Bedroom Apartment (County)Gross rent estimate for a three bedroom apartment; includes the shelter rent plus the cost of all tenant-paid utilities, except telephones, cable or satellite television service, and internet service.
THREE_BEDINDEXGross Rent Index – Three-Bedroom ApartmentLocalized index to show expected local pricing variations for a three bedroom dwelling.
FOUR_BED_COUNTYGross Rent Estimate – Four-Bedroom Apartment (County)Gross rent estimate for a four bedroom apartment; includes the shelter rent plus the cost of all tenant-paid utilities, except telephones, cable or satellite television service, and internet service.
FOUR_BEDINDEXGross Rent Index – Four-Bedroom ApartmentLocalized index to show expected local pricing variations for a four bedroom dwelling.
LANGASIAN_00Households by Language 2000 - AsianNumber of Asian and Pacific Island speaking households in 2000.
LANGENG_00Households by Language 2000 - EnglishNumber of English speaking households in 2000.
LANGEURO_00Households by Language 2000 - EuropeanNumber of European speaking households in 2000.
LANGOTHER_00Households by Language 2000 - OtherNumber of households speaking a language classified as Other in 2000.
LANGSPAN_00Households by Language 2000 - SpanishNumber of Spanish speaking households in 2000.
RACEWHITE_90Race 1990 - WhiteNumber of people living within the area in 1990, whose race was White.
RACEASIAN_90Race 1990 - AsianNumber of people living within the area in 1990, whose race was Asian.
RACEBLACK_90Race 1990 - BlackNumber of people living within the area in 1990, whose race was Black.
RACEHISP_90Race 1990 - HispanicNumber of people living within the area in 1990, whose race was Hispanic.
RACEOTHER_90Race 1990 - OtherNumber of people living within the area in 1990, whose race was listed as Other.
RACEWHITE_00Race 2000 - WhiteNumber of people living within the area in 2000, whose race was White.
RACEAMERIND_00Race 2000 - American IndianNumber of people living within the area in 2000, whose race wss American Indian, Eskimo, or Aleut.
RACEASIAN_00Race 2000 - AsianNumber of people living within the area in 2000, whose race was Asian.
RACEBLACK_00Race 2000 - BlackNumber of people living within the area in 2000, whose race was Black.
RACEHAWAI_00Race 2000 - HawaiianNumber of people living within the area in 2000, whose race was Hawaiian/Pacific Islander.
RACEMULTI_00Race 2000 - MultiNumber of people living within the area in 2000, whose race was of multiple types.
RACEOTHER_00Race 2000 - OtherNumber of people living within the area in 2000, whose race was listed as Other.
HHD_90Households - 1990Number of households in the area in 1990.
HHD_00Households - 2000Number of households in the area in 2000.
HHDAVESZ_00Average Household Size - 2000Average size of area households in number of people in 2000.
HHPOP_00Population in Households - 2000Number of people living in households in 2000. People not living in households are classified as living in group quarters (which include correctional facilities, nursing facilities, college dormitories, military barracks, group homes, homeless shelters, etc.)
NINE_TO_12_1990Education 1990: Grades 9 -12Number of students enrolled in grades 9-12 in 1990.
NINE_TO_12_2000Education 2000: Grades 9 -12Number of students enrolled in grades 9-12 in 2000.
EDUAGELT9_90Education 1990: Enrolled Grade 9 or lowerEducational Enrollment from Census 1990: Number of people enrolled in grade 9 or below.
EDUHSCH_90Education 1990: HighschoolEducation attainment from Census 1990: Number of people who achieved a highschool education.
EDUSCOLL_90Education 1990: Some CollegeEducation attainment from Census 1990: Number of people who achieved some college education.
EDUTOTALPOP_90Education 1990: Total EducatedEducation attainment from Census 1990: Total population by education.
EDUCOLL_90Education 1990: CollegeEducation attainment from Census 1990: Number of people who achieved a college education.
EDUAGELT9_00Education 2000: Under Grade 9Education attainment from Census 2000: Number of people who achieved an 8th grade education.
EDUHSCH_00Education 2000: HighSchoolEducation attainment from Census 2000: Number of people who achieved a highschool education.
EDUSCOLL_00Education 2000: Some CollegeEducation attainment from Census 2000: Number of people who achieved some college education.
EDUCOLL_00Education 2000: CollegeEducation attainment from Census 2000: Number of people who achieved a college education.
EDUASSOC_00Education 2000: AssociateEducation attainment from Census 2000: Number of people who achieved an Associate's Degree.
EDUBACH_00Education 2000: BachelorEducation attainment from Census 2000: Number of people who achieved a Bachelor's Degree.
EDUDEGREE_00Education 2000: Advanced DegreeEducation attainment from Census 2000: Number of people who achieved an Advanced Degree.
EDUTOTALPOP_00Education 2000: Total EducatedEducation attainment from Census 2000: Total population by education.
ENROLLPREK_90Educational Enrollment 1990: Pre-KindergartenEducational Enrollment from Census 1990: Number of students enrolled in pre-kindergarten.
ENROLLELEM_90Educational Enrollment 1990: ElementaryEducational Enrollment from Census 1990: Number of students enrolled in elementary school.
ENROLLCOLL_90Educational Enrollment 1990: CollegeEducational Enrollment from Census 1990: Number of people enrolled in college.
ENROLLTOTAL_90Educational Enrollment 1990: TotalTotal number of people enrolled in school in 1990.
ENROLLPREK_00Educational Enrollment 2000: Pre-KindergartenEducational Enrollment from Census 2000: Number of students enrolled in pre-kindergarten.
ENROLLELEM_00Educational Enrollment 2000: ElementaryEducational Enrollment from Census 2000: Number of students enrolled in elementary school.
ENROLLHSCH_00Educational Enrollment 2000: High SchoolEducational Enrollment from Census 2000: Number of students enrolled in highschool.
ENROLLCOLL_00Educational Enrollment 2000: CollegeEducational Enrollment from Census 2000: Number of people enrolled in college.
ENROLLTOTAL_00Educational Enrollment 2000: TotalTotal number of people enrolled in school in 2000.
POP_90Population 1990Number of people living in the area in 1990.
POPGQ_90Group Quarters Population 1990Number of people within the area living in group quarters (institutional and non-institutional) in 2000.
POP_00Population 2000Number of people living in the area in 2000.
POPFEMALE_00Female Population 2000Number of females living within the area in 2000.
POPMALE_00Male Population 2000Number of males living within the area in 2000.
LBF_00In Labor Force 2000Number of people available for work in 2000.
LBFAF_00In Labor Force 2000: Armed ForcesNumber of people who were members of the U.S. Armed Forces (people on active duty with the United States Army, Air Force, Navy, Marine Corps, or Coast Guard) in 2000.
LBFCIV_00In Labor Force 2000: CivilianNumber of people who had jobs or were seeking a job, were at least 16 years old, not serving in the military and were not institutionalized in 2000.
LBFEMP_00In Labor Force 2000: Civilian, EmployedNumber of people in the civilian noninstitutional population classified as either employed or unemployed. in 2000.
LBFWF_00Total Work Force 2000Total number of people who could be employed in 2000.
EMPMIL_00Employment: Military 2000Number of people employed by the U.S. Government in 2000.
POPCORR_00Population Group Quarters 2000: CorrectionalNumber of people within the area living in correctional facilities in 2000.
POPINST_00Population Group Quarters 2000: InstitutionalizedNumber of people within the area living in institutional facilities in 2000.
POPNONINST_00Population Group Quarters 2000: Non-InstitutionalizedNumber of people within the area living in non-institutional facilities in 2000.
POPNURSHM_00Population Group Quarters 2000: Nursing HomeNumber of people within the area living in nursing facilities in 2000.
POPOTHERINST_00Population Group Quarters 2000: Other InstitutionalizedNumber of people within the area living in other institutionalized facilities in 2000.
POPOTHERNONINST_00Population Group Quarters 2000: Other Non-InstitutionalizedNumber of people within the area living in other non-institutionalized facilities in 2000.
POP_10Population 2010Number of people living in the area in 2010.
POPGQ_00Population Group Quarters 2000: TotalNumber of people within the area living in group quarters (institutional and non-institutional) in 2000.
AVGSALEPRICEAverage Home Sale PriceAverage residential home sales price for four recent quarters. Based on actual sales collected from Assessor’s offices. All included sales are arms length transactions greater than $25,000 representing single family and multi-family (2 – 4) residential sales.
* Note: This field is only available for approximately 2,500 counties nationally.
SALECOUNTCount of Home SalesHome sales count for four recent quarters. Based on actual sales collected from Assessor’s offices. All included sales are arms length transactions greater than $25,000 representing single family and multi-family (2 – 4) residential sales.
Note: This field is only available for approximately 2,500 counties nationally.
MEDSALEPRICE Median Home Sale PriceMedian residential home sales price for four recent quarters. Based on actual sales collected from Assessor’s offices. All included sales are arms length transactions greater than $25,000 representing single family and multi-family (2 – 4) residential sales.
Note: This field is only available for approximately 2,500 counties nationally.


Release Notes

Property API

What's New?

We have made updates to our Property API!

We have added a new filter that allows you to search by the absentee owner status of a home. This has been applied to all of our property API searches and see the details for the new filter in our Search Filters table.

The County Use 2 and Mortgage Assumption Amount fields have been removed from all API calls because they are no longer available.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have made updates to our AVM data and school API calls!

Our AVM data now includes different high and low values based on the condition of a home (poor, good, and excellent). This will help your clients adjust the valuation of a property based on the condition through your product and allow them to interact more with your product. This data is not available within the /allevents/detail or /avm/detail calls.

The update to the /school/detail API call has added the geoID of the school boundary that you are searching. This helps your customers if they wanted to search for homes in a specific school zone and makes your API integration more efficient.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have made an update to our /school/snapshot call to include filtering by the type of school (filetypetext field). The different options are public, private, and catholic schools.

Our /property/detailwithschools call will return schools based on the attendance zone of the schools nearby, but as you may know, private schools don't have attendance zones.

We added the school/snapshot call mainly to allow you to search for private schools in a way (point and radius search) that made sense and adding the ability to filter by something like private schools, will make your searching more efficient.

Keep an eye out for our new /school/districtdetail call coming soon that will allow you to gather details about a school district associated to the school data that we just added.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have added all of our Sale Trends data to our Property API!

This data will be available through access to our standard plans and has been added through the /salestrend/snapshot call.

The new call will return average sale price, median sale price, and sale counts for the zip code that you are searching in. You will be able to search for sales trends going back two years and return them in increments of months, quarters, and years.

We have also added a new field in the /avm/detail call that will show the percentage change in the AVM for a property between the previous month and the current month.

Keep an eye out for our new /school/districtdetail call coming soon that will allow you to gather details about a school district associated to the school data that we just added.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have added all of our School Data to our Property API!

This data will be available through access to our standard plans and has been added to the /property/detailwithschools, /school/snapshot, and /school/detail calls.

The property/detailwithschools call will now return the school names and other summary data for institutions within the school boundaries that the property falls within. The /school/snapshot call will return the same information, but uses a lat/long and radius search to return schools, which is helpful for including private institutions. The /school/detail call will return all of the details that we capture for any particular institution.

If you are looking to dig through the specific data fields, please check out our School Data Dictionary for definitions.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New in 1.2

We have added the highly-anticipated mortgage and owner datasets to our Property API data offering. The datasets will include data fields such as property owner contact information, mortgage details, and mortgage lender information. Please see our Property API Data Dictionary for the full list of data fields returned.

What can Onboard's Owner and Mortgage Data do for my Business?

There are many ways your business can leverage these dataset to prospect and nurture leads, and develop business and marketing strategies:

  • Augment your leads by supplementing with mortgage information
  • Kickstart a personalized direct mail campaign by creating a marketing list from the owner data
  • Perform equity analysis to identify potential upcoming sellers
These are just a few of the many ways your business can strategically identify, enhance, and convert leads into revenue.

Owner and Mortgage Data Response Packages:

  • Mortgage.lender: Mortgage lender name, address, and company code.
  • Mortgage.title: Mortgage title company name and code.
  • Mortgage: Mortgage amount, date, interest rate, term, due date, deed type, equity and refinance flags.
  • Owner: Owner contact information and mailing address; C/O name; owner relationship type and rights code; and indicator flags for partial interest and absentee owner.

If you are interested in acquiring or upgrading a license plan to obtain owner and mortgage data, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have added Maponics School Attendance Zone boundaries (Geography IDs SB and DB) to our Property API. Any school or district boundary associated to a property will be listed under the attribute, "geoid".

As previously communicated, our partnership with Maponics also has resulted in Onboard sunsetting its neighborhood and school attendance products. This sunset date was set for August 31, 2016. As of October 25, 2016, you will no longer see the geography types NH, SS or SD in results returned from our Property or other APIs available through the platform.

If you are still in the process of migrating to Maponics boundaries, we have some tools to help. Please check out our Maponics documentation folder for additional mapping documents and lookups.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What’s new in 1.1

This beta release includes many bug fixes and stabilizes the Property API code base. The following list contains the features and bugs worked on in this Beta 2 release:

  • Performance improvements for radius search
  • Improved address search for unit numbers
  • Added new filter for debug=”true” to include all fields, not just those populated

The Onboard team wants also to thank you for all the feedback on the previous beta release. Keep testing! If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

The Onboard team would like to announce the release of the PROPERTY API BETA!

This API is designed to help you to integrate U.S. property information into any application that can interact with a REST API. Until now, this public record data has been either too costly or too difficult to work with for most organizations. We are excited to make this data available on a national scale, in an organized and cost-effective way.

We hope you enjoy test driving our API! If you have any questions, please contact us. Email our Team: support@onboardinformatics.com

Area API

What's New?

We have made updates to our Area API!

The /hierarchy/lookup API call has been updated to make searching easier and more efficient.

The API call now accepts latitude and longitude as inputs, as opposed to only points from a WKT string, which became difficult because the latitude and longitude order was switched.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have added a filter to the /heirarchy/lookup that allows you to filter by the type of geo id to be returned.

This new filter can help your performance if you are only interested in one type of geo id being returned in your search. For example, if you only want to know which school boundaries a given lat/long exists in, just add a filter for "SB." This will return only school boundaries in the response, as opposed to all possible boundary types.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have added new search functionality to our Area API!

If you have run into some trouble searching for Geo IDs within other Geo IDs (residential subdivisions within a zip code for example) this new API call will help.

The new call will allow you to search for Geo IDs that exist within another known Geo ID. The response will include the names of the Geo IDs, the square mileage and the ID of each area returned. In addition, if you were to search a school boundary within a zip code, the zip codes that the school boundary falls within would be returned.

We have also made some performance improvements to our /hierarchy/lookup call that allow for much faster searching of Geo IDs based on a latitude and longitude input.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's New?

We have added Maponics School Attendance Zone boundaries (Geography IDs SB and DB) to our Area API.

As previously communicated, our partnership with Maponics also has resulted in Onboard sunsetting its neighborhood and school attendance products. This sunset date was set for August 31, 2016. As of October 25, 2016, you will no longer see the geography types NH, SS or SD in results returned from our Area or other APIs available through the platform.

If you are still in the process of migrating to Maponics boundaries, we have some tools to help. Please check out our Maponics documentation folder for additional mapping documents and lookups.

.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's new in 2.0

Notable changes to the API include new naming conventions used for specific boundary types. Names are related to the “type” field. The following table indicates the current naming convention and the new convention:

Current Name New Name Description
CBSA CB Core Based Statistical Area representing a major metro
Census Place* PL US Census Bureaue designated place (city)
County CO County or county equivalent
Census Place* CS County subdivision (town, hamlet or unincorporated place)
Neighborhood NH Neighborhood not defined by government authority (deprecated)
State ST U.S. State
Zip Code ZI ZCTA or Census ZIP Code Tabulation Area


*NOTE: Onboard has chosen to use either Census Place OR County Subdivision boundaries in certain areas where the geography type best fits the local understanding and designation of geographies.

We’ve also added several new area types added to the API.

New Type Description
ND Maponics defined neighborhood boundary.
RS Maponics defined residential boundary. These boundaries delineate neighborhoods with houses, condos and apartment complexes, and exclude those with commercial, industrial or public spaces
MT Maponics defined metro boundary. These boundaries include urban areas in which population concentration is greater than 50,000 and population density is greater than 1,000 people per square mile.
PZ Postal ZIP, representing an expanded set of ZIP Codes not documented by the US Census Bureau
SD School District
SS School Attendance zone representing the catchment area for a specific school and grade level

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

Points of Interest API

What's new?

We have made updates to our POI API!

The /poi/point and /poi/street+address API calls have both been updated to make searching easier and more efficient.

The /poi/point API call now accepts latitude and longitude as inputs, as opposed to only points from a WKT string, which became difficult because the latitude and longitude order was switched.

The /poi/street+address call now accepts our standard address1 and address2 fields for searching so you no longer need to add a semi colon in the middle of your address.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's new?

We have added the functionality to allow for filtering by Business Category in the POI API!

This filter is available within the /poi/point call and will allow you to filter results by one-to-many Business Categories, such as eating-drinking, shopping, etc… for all 14 business categories.

If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

What's new in 2.0

Notable changes to the API include the change to the base URL structure and updated security.



URL Structure


V1 URL Structure

http://api.ist_prod.obiwebservices.com/POI+Search/POI/Street+Address/?&AccessToken=&StreetAddress=90+broad+street,+new+york,+ny;+10004


V2 URL Structure

https://search.onboard-apis.com/poiapi/v2.0.0/POI/Street+Address/streetaddress=90+broad+street,+new+york,+ny;+10004 


Updated Security


Users are no longer required to include their "AccessToken" in the URL request. Instead you'll need to include your APIKey in the request header.


Other Changes


V1 required users to include either mime=xml or mime=json in their URL string to indicate the type of response requested. This is still supported in V2. However, a user can also choose to set "Accept" to either application/json or application/xml in the header to receive the same result.


Test drive the new version of the API today! You can try out the calls in the Interactive Docs or sign up for a FREE trial account.


If you have any questions, please contact us! Email our Team: support@onboardinformatics.com

Community API

What's new in 2.0

Notable changes to the API include the change to the base URL structure and updated security.



URL Structure


V1 URL Structure

http://api.ist_prod.obiwebservices.com/Community/Area/Full/?&AreaId=NH0031106&AccessToken= 


V2 URL Structure

https://search.onboard-apis.com/communityapi/v2.0.0/area/full?AreaId=CO44003


Updated Security


Users are no longer required to include their "AccessToken" in the URL request. Instead you'll need to include your APIKey in the request header.


Other Changes


V1 required users to include either mime=xml or mime=json in their URL string to indicate the type of response requested. This is still supported in V2. However, a user can also choose to set "Accept" to either application/json or application/xml in the header to receive the same result.


Test drive the new version of API today! You can try out the calls in the Interactive Docs or sign up for a FREE trial account.


If you have any questions, please contact us! Email our Team: support@onboardinformatics.com