clientapi.nicmapvision.com
Open in
urlscan Pro
52.251.55.109
Public Scan
Submitted URL: https://clientapi.nicmapvision.com/
Effective URL: https://clientapi.nicmapvision.com/index.html
Submission: On March 22 via automatic, source certstream-suspicious — Scanned from DE
Effective URL: https://clientapi.nicmapvision.com/index.html
Submission: On March 22 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 1 forms found in the DOM
<form class="download-url-wrapper"><label class="select-label" for="select"><span>Select a definition</span><select id="select">
<option value="/swagger/v1/swagger.json">V1</option>
</select></label></form>Text Content
Client API Developer Documentation
Select a definitionV1
GETTING STARTED
Welcome to the NIC MAP Client API Developer Documentation. This document will
show you the available end points, parameters, and methods available for you to
configure on your systems. To get started, you need an active NIC MAP
Subscription with Client API Product Access and an API Key. If you do not have
either of these items, please contact Client Services by emailing them at
support@nic.org.
Click Authorize and enter your API Key to view sample calls in the sections
below and get started using the NIC MAP Client API.
Check the Client API Status page to view the status for each endpoint.
REQUEST FORMATS
Each request contains a header and body. The header must consist of the
following parameters:
{
"api-key": "key provided by client services"
}
Use the Geography endpoints below to find the markets, regions, metropolitan
areas, and counties accessible according to your subscription. These endpoints
will return the ID's to use in your requests.
Use the Supply endpoints below to get property information based on a radius, a
rectangle (bounding box), ZIP Code, metropolitan area, or county. Additional
search criteria, such as property status, age, profit type, can be added to a
Supply request. The available criteria can be found by clicking the Supply
endpoint name and selecting the Model in the Example View. The lookup endpoints
for Campus Type, Age, and Property Type that can be used to find the values for
a Supply request are listed below.
Use the Trends endpoints below to get historical time series data by Property
Type or Community Type. Additional search criteria, such as campus types can be
added to a Trends request. The available criteria can be found by clicking the
Trends endpoint name and selecting the Model in the Example View. The lookup
endpoints for Campus Type, Age, Property Type, and Community Type can be used to
find the values for a Trends request are listed below.
The TrendsGeographyFilter is a class that takes a “GeographyType”, which is a
required value, and “GeographyTypeValues”, which is an array of values for the
GeographyType provided. GeographyType takes values 0, 1, 2, and 3. 0 is for
Markets, 1 is for Regions, 2 is for Metros, and 3 is for Counties. You must pass
in at least one of these values to return Trends information for that geography
type.
Use the SalesTransactions endpoints below to get transaction information based
on a radius, a rectangle (bounding box), ZIP Code, metropolitan area, or county.
Additional search criteria, such as sales price, sale date, and price per unit
can be added to a Sales Transactions request. The available criteria can be
found by clicking the SalesTransactions endpoint name and selecting the Model in
the Example View. The lookup endpoints for Campus Type, Property Type, and
Buyer/Seller Types that can be used to find the values for a SalesTransactions
request are listed below.
RESPONSE FORMATS
Responses are in a JSON format. In addition to the data requested, each response
header includes the number of calls remaining for the day. A call is deducted
from your daily total for each request that contain a valid API Key, regardless
of if the call was a success or failure.
If the LogOnly querystring is appended to the POST url with the value of TRUE, a
204 Response will be returned with no data. For example, if you want to log a
Trends PropertyType request format the url as follows:
/api/v1/TrendsPropertyType?logonly=true
Authorize
API ENDPOINT REFERENCE
GENERAL
GET/api/v1/General/Vintage
Gets data vintage categories for use in requests
GEOGRAPHY
GET/api/v1/Geography/Metros
Gets metro codes and names based on subscription access
GET/api/v1/Geography/Counties
Gets county FIPS codes and names based on subscription access
GET/api/v1/Geography/Markets
Gets NIC MAP markets
GET/api/v1/Geography/Regions
Gets NIC MAP Regions
GET/api/v1/Geography/Types
Gets GeographyType values
SALESTRANSACTIONS
GET/api/v1/SalesTransactions/PropertyTypes
Gets all property type categories for sales transaction requests
GET/api/v1/SalesTransactions/CampusTypes
Gets all campus type categories for sales transactions requests
GET/api/v1/SalesTransactions/BuyerSellerTypes
Gets all buyer and seller type categories for sales transaction requests
POST/api/v1/SalesTransactions/GetTransactionsInMetro
POST/api/v1/SalesTransactions/GetTransactionsInCounty
POST/api/v1/SalesTransactions/GetTransactionsInZipCode
POST/api/v1/SalesTransactions/GetTransactionsInRadius
POST/api/v1/SalesTransactions/GetTransactionsInBox
SUPPLY
GET/api/v1/Supply/CampusTypes
Gets all campus types for supply requests
GET/api/v1/Supply/SegmentTypes
Gets all segment types for supply requests
GET/api/v1/Supply/PropertyAgeCategories
Gets all property age categories for supply requests
GET/api/v1/Supply/PropertyTypes
Gets all property types for supply requests
POST/api/v1/Supply/GetPropertiesInMetro
POST/api/v1/Supply/GetPropertiesInCounty
POST/api/v1/Supply/GetPropertiesInZipCode
POST/api/v1/Supply/GetPropertiesInRadius
POST/api/v1/Supply/GetPropertiesInBox
TRENDSCOMMUNITYTYPE
GET/api/v1/TrendsCommunityType/CommunityTypes
Gets all community types categories for trends community type requests
GET/api/v1/TrendsCommunityType/CampusTypes
Gets all campus type categories for trends community type requests
GET/api/v1/TrendsCommunityType/PropertyAgeCategories
Gets all property age categories for trends community type requests
POST/api/v1/TrendsCommunityType
TRENDSPROPERTYTYPE
GET/api/v1/TrendsPropertyType/PropertyTypes
Gets all property type categories for trends property type requests
GET/api/v1/TrendsPropertyType/CampusTypes
Gets all campus type categories for trends property type requests
GET/api/v1/TrendsPropertyType/PropertyAgeCategories
Gets all property age categories for trends property type requests
POST/api/v1/TrendsPropertyType
SCHEMAS
Address
BuyerSellerType
CampusType
CommunityType
County
DateTimeMinMax
FilterType
GeographyType
Int32MinMax
Market
Metro
Property
PropertyAgeCategory
PropertyType
PropertyUnits
ProtectedTrendsInformation
Region
SalesTransaction
SearchByBox
SearchByCounty
SearchByMetro
SearchByRadius
SearchByZipCode
SegmentType
TransactionSearchByBox
TransactionSearchByCounty
TransactionSearchByMetro
TransactionSearchByRadius
TransactionSearchByZipCode
TrendsDataFilterCommunityType
TrendsDataFilterPropertyType
TrendsGeographyFilter
Vintage
© 2024 NIC MAP Vision. All rights reserved.
1.0.0.0