Retsly API Explorer

/datasets

Description

Retrieves a set of Datasets


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
fields
string
Filters Response fields eg. fields=id,price.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).
box
string
Coordinates representing a box eg. box=-112.5,33.75,-123,39
poly
string
Minimum 3 pairs of coordinates representing a polygon eg. poly=-112.5,33.75,-123,39,-120,38

Response

Name
Type
Description
vendorID
string
Unique identifier for the dataset.
name
string
Dataset name.
logo
string
Path to the dataset logo image.
test
boolean
Identifies Retsly test datasets.
type
string
Type of dataset eg. mls.
update
string
Update timestamps for dataset resources.
center
[number]
long/lat coordinates for the center of the dataset.
boundary
[array]
Array of long/lat coordinates for the center of the dataset.
activeAgents
string
The total active agents.
activeListings
string
The total active listings.
activeOffices
string
The total active offices.

Example Code

Example URL
https://rets.io/api/v1/datasets?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "activeOffices": 896,
      "activeListings": 209,
      "activeAgents": 506,
      "name": "TEST",
      "type": "mls",
      "test": true,
      "vendorID": "test",
      "logo": "https://retsly_images_development.s3.amazonaws.com/uploads/test/logo/retsly_test_1.png",
      "state": "WA",
      "boundary": [
        [
          [
            -124.661865234375,
            41.672911819602085
          ],
          [
            -124.135498046875,
            38.12544756511612
          ],
          [
            -120.135498046875,
            34.12544756511612
          ],
          [
            -116.136474609375,
            36.1733569352216
          ],
          [
            -119.696044921875,
            38.788345355085625
          ],
          [
            -119.652099609375,
            41.77131167976406
          ]
        ]
      ],
      "center": [
        -122.4192704,
        37.7792768
      ],
      "id": "5463b36bf8a8866b9fb57f6a"
    },
    {
      "activeOffices": 74,
      "activeListings": 0,
      "activeAgents": 488,
      "name": "San Francisco Test Data",
      "type": "mls",
      "test": true,
      "vendorID": "test_sf",
      "logo": "https://retsly_images_development.s3.amazonaws.com/uploads/test_sf/logo/retsly_test_3.png",
      "boundary": [
        [
          [
            -122.504118,
            37.717041
          ],
          [
            -122.504118,
            37.766792
          ],
          [
            -122.384213,
            37.766792
          ],
          [
            -122.384213,
            37.717041
          ],
          [
            -122.504118,
            37.717041
          ]
        ]
      ],
      "center": [
        -122.44803428649902,
        37.75144384252926
      ],
      "id": "5463b36bf8a8866b9fb57666"
    },
    {
      "activeOffices": 61,
      "activeListings": 0,
      "activeAgents": 296,
      "name": "San Diego Test Data",
      "type": "mls",
      "test": true,
      "vendorID": "test_sd",
      "logo": "https://retsly_images_development.s3.amazonaws.com/uploads/test_sd/logo/retsly_test_2.png",
      "state": "CA",
      "boundary": [
        [
          [
            -117.205885,
            32.739547
          ],
          [
            -117.205885,
            32.80605
          ],
          [
            -117.054179,
            32.80605
          ],
          [
            -117.054179,
            32.739547
          ],
          [
            -117.205885,
            32.739547
          ]
        ]
      ],
      "center": [
        -117.1237850189209,
        32.76454748492845
      ],
      "id": "5463b36bf8a8866b9fb57667"
    }
  ],
  "total": 3
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/datasets
Getting Response
Response Status
Response Body
Your Response Here

GET

/datasets/{dataset}

Description

Retrieves a single Dataset


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.

Response

Name
Type
Description
vendorID
string
Unique identifier for the dataset.
name
string
Dataset name.
logo
string
Path to the dataset logo image.
test
boolean
Identifies Retsly test datasets.
type
string
Type of dataset eg. mls.
update
string
Update timestamps for dataset resources.
center
[number]
long/lat coordinates for the center of the dataset.
boundary
[array]
Array of long/lat coordinates for the center of the dataset.
activeAgents
string
The total active agents.
activeListings
string
The total active listings.
activeOffices
string
The total active offices.

Example Code

Example URL
https://rets.io/api/v1/datasets/test?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "activeOffices": 896,
    "activeListings": 209,
    "activeAgents": 506,
    "_id": "5463b36bf8a8866b9fb57f6a",
    "name": "TEST",
    "type": "mls",
    "test": true,
    "vendorID": "test",
    "logo": "https://retsly_images_development.s3.amazonaws.com/uploads/test/logo/retsly_test_1.png",
    "state": "WA",
    "__v": 0,
    "isPublic": false,
    "scopes": [
      "56326fdc8cd446f0d042cc88",
      "56326fdc8cd446f0d042cc89",
      "56326fdc8cd446f0d042cc8a",
      "56326fdc8cd446f0d042cc8b",
      "56326fdc8cd446f0d042cc8c"
    ],
    "boundaryGeoJSON": {
      "coordinates": [
        [
          [
            -124.661865234375,
            41.672911819602085
          ],
          [
            -124.135498046875,
            38.12544756511612
          ],
          [
            -120.135498046875,
            34.12544756511612
          ],
          [
            -116.136474609375,
            36.1733569352216
          ],
          [
            -119.696044921875,
            38.788345355085625
          ],
          [
            -119.652099609375,
            41.77131167976406
          ]
        ]
      ],
      "type": "MultiPolygon"
    },
    "centerGeoJSON": {
      "coordinates": [
        -122.4192704,
        37.7792768
      ],
      "type": "Point"
    },
    "crud": [
      "read",
      "create",
      "update",
      "del"
    ],
    "boundary": [
      [
        [
          -124.661865234375,
          41.672911819602085
        ],
        [
          -124.135498046875,
          38.12544756511612
        ],
        [
          -120.135498046875,
          34.12544756511612
        ],
        [
          -116.136474609375,
          36.1733569352216
        ],
        [
          -119.696044921875,
          38.788345355085625
        ],
        [
          -119.652099609375,
          41.77131167976406
        ]
      ]
    ],
    "center": [
      -122.4192704,
      37.7792768
    ],
    "id": "5463b36bf8a8866b9fb57f6a"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/datasets/{dataset}
Getting Response
Response Status
Response Body
Your Response Here

GET

/datasets/approved

Description

Retrieves a list of datasets who have approved this application.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
fields
string
Filters Response fields eg. fields=id,price.

Response

Name
Type
Description
vendorID
string
Unique identifier for the dataset.
name
string
Dataset name.
logo
string
Path to the dataset logo image.
test
boolean
Identifies Retsly test datasets.
type
string
Type of dataset eg. mls.
update
string
Update timestamps for dataset resources.
center
[number]
long/lat coordinates for the center of the dataset.
boundary
[array]
Array of long/lat coordinates for the center of the dataset.
activeAgents
string
The total active agents.
activeListings
string
The total active listings.
activeOffices
string
The total active offices.

Example Code

Example URL
https://rets.io/api/v1/datasets/approved?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "activeOffices": 896,
      "activeListings": 209,
      "activeAgents": 506,
      "name": "TEST",
      "type": "mls",
      "test": true,
      "vendorID": "test",
      "logo": "https://retsly_images_development.s3.amazonaws.com/uploads/test/logo/retsly_test_1.png",
      "state": "WA",
      "boundary": [
        [
          [
            -124.661865234375,
            41.672911819602085
          ],
          [
            -124.135498046875,
            38.12544756511612
          ],
          [
            -120.135498046875,
            34.12544756511612
          ],
          [
            -116.136474609375,
            36.1733569352216
          ],
          [
            -119.696044921875,
            38.788345355085625
          ],
          [
            -119.652099609375,
            41.77131167976406
          ]
        ]
      ],
      "center": [
        -122.4192704,
        37.7792768
      ],
      "id": "5463b36bf8a8866b9fb57f6a"
    }
  ],
  "total": 3
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/datasets/approved
Getting Response
Response Status
Response Body
Your Response Here

/users

Description

Retrieve a user associated with a user token.



Response

Name
Type
Description
id
string
Unique retsly id.
firstName
string
User first name.
lastName
string
User last name.
email
string
User email.
tokens
object
Information regarding oauth user token.

Example Code

Example URL
https://rets.io/api/v1/users?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "firstName": "Sigmund",
      "lastName": "Greenfelder",
      "email": "etha_wisozk@perferendis.biz",
      "id": "5638085ceb3ea9430780c52f",
      "tokens": {
        "js": {
          "access_token": "c248b3ce5cdab8d3f685b99a875a8f28",
          "expires_at": "2015-11-03T04:05:32.675Z"
        }
      }
    }
  ]
}
This endpoint isn't supported by the API Explorer.

/applications

GET

/applications

Description

Retrieves a set of Applications associated with a user token.



Response

Name
Type
Description
name
string
Application name.
status
string
App status: reviewed, inReview, incomplete , rejected, or suspended.
domains
[string]
Application domains.
icon
object
Urls for uploaded icon and resizes.
screenshots
[object]
Urls for uploaded screenshots and resizes.
clientID
string
Unique Retsly identifier.
secret
string
Application secret... don't tell anybody!
vendors.vendor
string
The name of the application.
vendors.status
string
The status of the application.
user.firstName
string
User first name.
user.lastName
string
User last name.
user.email
string
User email.
user.id
string
Unique retsly id.

Example Code

Example URL
https://rets.io/api/v1/applications?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "name": "Hessel Group",
      "status": "reviewed",
      "domains": [
        "https://mydomain.com"
      ],
      "vendors": [
        {
          "vendor": "pub",
          "status": "approved"
        },
        {
          "vendor": "test",
          "status": "approved"
        },
        {
          "vendor": "test_sf",
          "status": "approved"
        },
        {
          "vendor": "test_sd",
          "status": "approved"
        }
      ],
      "icon": {
        "original": "https://rets.ly/images/icon_3.svg"
      },
      "screenshots": [],
      "clientID": "3Kptou0fywb3y9EZsFRk",
      "user": {
        "firstName": "Queenie",
        "lastName": "O'Connell",
        "email": "berry.wiza@tenetur.com",
        "id": "56393b321065d6a4ce3efd12"
      }
    }
  ],
  "total": 1
}
This endpoint isn't supported by the API Explorer.

/listings

GET

/{dataset}/listings

Description

Retrieves a set of listings.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).
box
string
Coordinates representing a box eg. box=-112.5,33.75,-123,39
poly
string
Minimum 3 pairs of coordinates representing a polygon eg. poly=-112.5,33.75,-123,39,-120,38
geohash
string
Alphanumeric geohash eg. geohash=ezs42

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the listing.
originatingSystemKey
string
The unique identifier from the originating system which is commonly a key to that system.
originatingSystemName
string
The name of the originating record provider. Most commonly the name of the MLS.
mlsListingID
string
The well known identifier for the listing.
unitNumber
string
The unit number pertaining to apartments, etc.
streetName
string
The street name for the listing property.
streetNumber
string
The street number for the listing property.
city
string
The city which the listing property resides in.
state
string
The state which the listing property resides in.
county
string
The county with which the listing property resides in.
country
string
The country with which the listing property resides in.
zipCode
string
The postal code for the listing property.
subdivision
string
The name of the subdivision if the listing property has one.
listDate
string
The date of the agreement between the seller and the seller's broker.
lastModified
string
The date which the posted listing was last modified.
price
number
The current price of the listing property.
previousPrice
number
The last price of the listing property.
originalPrice
number
The first price of the listing property.
closePrice
number
The closing price of the listing property.
buyerFinancing
string
A list of options that describe the type of financing used.
buyerAgencyCompensation
string
The total commission to be paid for this sale, expressed as either a percentage or a constant currency amount.
concessions
string
Are there concessions included in the sales agreement?
concessionsComments
string
Comments describing the concessions made by the buyer or the seller.
concessionsAmount
number
The dollar amount of the concessions
contingency
string
A list of contingencies that must be satisfied in order to complete the transaction.
disclosures
[string]
A list of legal or pertinent information that should be disclosed to potential buyer's agents.
unitsInBuilding
number
The total number of units in the building if applicable.
cancelationDate
string
The cancelation date of the listing if applicable.
expirationDate
string
The expiration date of the listing if applicable.
dateListed
string
The date that the property was first listed.
dateSold
string
The date that the property was sold.
statusChange
string
The date that the contractual status of the listing property was changed.
developmentStatus
[string]
A list of the development status of the property.
ownership
string
A text description of the manner in which title to a property is held.
signOnProperty
boolean
Is there a sign on the property.
financialDataSource
string
A list of the rental information, e.g. Accountant, Owner, etc.
yearBuilt
number
The year which the listing property was built.
yearBuiltDetails
string
A description of the details behind the year the structure was built.
daysOnMarket
number
The number of days the listing property has been posted on the market.
model
string
The model of the mobile or manufactured home.
appliances
[string]
A list of the appliances that will be included in the sale/lease of the property.
telephoneService
[string]
A list of telephone-service related features of the property.
view
[string]
A listed description of the view as seen from the listed property.
waterfront
boolean
A boolean value indicating waterfront property.
waterfrontFeatures
[string]
The features of the waterfront on which the property is located.
waterSource
[string]
A list of the source(s) of water for the property.
zoning
string
Typically a shortcode indicating the zoning given for the lot to discern permissible land uses.
zoningDescription
string
A list of descriptions of the zoning of the property.
acres
number
The number of acres dedicated to the lot of the listed property.
squareFootage
number
The total lot size of the property given in square feet.
livingArea
number
The total livable area within the structure.
entryLevel
number
A numeric field that describes the level within the structure, SFR or a unit in a building, where the main entry to the dwelling is located
aboveGradeFinishedArea
number
The finished area within the structure that is at or above the surface of the ground.
belowGradeFinishedArea
number
The finished area within the structure that is below ground.
stories
number
The number of floors in the property being sold.
storiesTotal
number
The total number of floors in the building.
commonWalls
[string]
A list with options indicating the presence of various types of common walls/wall partitions
baths
number
The simple sum of the number of bathrooms. Two half baths and a full bathroom would be 3 total.
halfBaths
number
The number of rooms containing 2 of 4 elements constituting a bath, e.g. toilet, sink, bathtub, shower.
bedrooms
number
The total number of bedrooms in the dwelling.
roomsTotal
number
The total number of rooms within the listed property.
fireplaces
number
The total number of fireplaces within the listed property.
fireplaceFeatures
[string]
A list of features or description of the fireplace(s) included in the sale/lease.
exteriorFeatures
[string]
A list of features or description of the exterior of the property.
newConstruction
boolean
Is the property newly constructed and has not been previously occupied?
homeWarranty
boolean
Is a home warranty included in the sale of the property?
architecturalStyle
[string]
A list describing the style of the structure.
elementarySchool
string
The name of the primary school having a catchment area that includes the associated property.
middleOrJuniorSchool
string
The name of the junior or middle school having a catchment area that includes the associated property.
highSchool
string
The name of the high school having a catchment area that includes the associated property.
directions
string
Driving directions to the property.
showingInstructions
string
Remarks that detail the seller's instructions for showing the subject property
communityFeatures
[string]
A list of features related to, or available within, the community.
patioAndPorchFeatures
[string]
A list of features or description of the patio or porch included in the sale/lease.
buildingFeatures
[string]
The features or amenities of the building or business park.
interiorFeatures
[string]
A list of features or description of the interior of the property included in the sale/lease.
parkingFeatures
[string]
A list of features or description of the parking included in the sale/lease
lotFeatures
[string]
A list of features or description of the lot included in the sale/lease.
basement
[string]
A list of information and features about the basement.
otherStructures
[string]
A list of structures other than the main dwelling.
lockboxType
[string]
A field describing the type of lock box.
lockboxLocation
string
A field describing the location of the lock box.
exclusions
string
The Elements of the property that will not be included in the sale
petsAllowed
[string]
Are pets allowed at the property being leased?
flooring
[string]
A list of the type(s) of flooring found within the property.
foundationDetails
[string]
A list of the type(s) of foundation on which the property sits.
frontageLength
number
Textual description of the length of the frontages for the listed property.
gas
[string]
A list of gas-service related features of the property.
accessibilityFeatures
[string]
A list or description of the accessibility features included in the sale/lease.
cooling
[string]
A list describing the cooling or air conditioning features of the property.
heating
[string]
A list describing the heating features of the property.
parcelNumber
string
A number used to uniquely identify a parcel or lot. Can vary between county and entered without dashes or hyphens.
additionalParcels
boolean
A boolean indicating if more than one parcel or lot is included in the sale.
occupantType
string
A field that describes the type of occupant, e.g. Owner, Tenant, Vacant.
pool
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
poolFeatures
[string]
A list of features or description of the pool included in the sale/lease.
poolPrivate
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
possession
[string]
A list defining when the possession will occur.
roadSurface
[string]
A list of types of surface of the road to access the property.
roof
[string]
A list describing the type or style of roof.
constructionMaterials
[string]
A list of materials that were used in the construction of the property.
sewer
[string]
A list describing the sewer or septic features of the property.
waterSewerExpense
number
The annual water and sewage sexpense that is not paid directly by the tenant and is included in the Operating Expense calculations.
garageSpaces
number
The number of spaces in the garage if applicable.
carportSpaces
number
The number of spaces in the carport if applicable.
openParking
boolean
A boolean indicating if there is open space parking.
attachedGarage
boolean
A flag indicating that the garage is attached to the dwelling.
carport
boolean
A flag indicating that the listing has a garage.
laundry
[string]
List of features and locations where the laundry is located in the property.
type
string
A list of types of properties such as Residential, Lease, Income, Land, Mobile, etc.
subtype
string
A list of types of residential and residential lease properties, e.g. SFR, Condo, etc.
publicRemarks
string
Text remarks that may be displayed to the public.
privateRemarks
string
Remarks that may contain security or proprietary information that should be restricted from public view.
agent
string
An ID used by Retsly to reference the agent associated with the listing.
mlsAgentID
string
A listing specific realtor's MLS ID number.
office
string
An ID used by Retsly to reference the office associated with the listing agent.
mlsOfficeID
string
A listing specific office's MLS ID number.
status
string
Local or regional MLS status.
contractStatusChangeDate
string
The date of the listings contractual status change.
contingentDate
string
The date an offer was made with a contingency.
withdrawnDate
string
Date the listing was withdrawn from the market.
offMarketDate
string
The date the listing was taken off market.
purchaseContractDate
string
With for-sale listings, the date an offer was accepted and the listing was no longer on market.
originalEntryTimestamp
string
The timestamp recorded by the MLS system representing the date/time the listing was entered.
taxAssessedValue
number
The property value as of the last assessment by the taxing authority.
taxAnnual
number
The annual property tax amount as of the last assessment made by the taxing authority.
taxYear
number
The year in which the last assessment of the property value/tax was made.
taxStatus
[string]
A list of the current tax statuses of the mobile home in cases where the land is included in the sale.
association
boolean
Is there a Home Owners Association.
associationName
string
The name of the Home Owners Association.
associationFee
number
A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common area, neighborhood or other association related benefits.
associationFeeFrequency
string
The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc.
associationFeeIncludes
[string]
Services included with the association fee. For example Landscaping, Trash, Water, etc
listingAgentFirstName
string
The first name of the listing agent.
listingAgentLastName
string
The last name of the listing agent.
listingAgentMiddleName
string
The middle name of the listing agent.
listingAgentFullName
string
The full name of the listing agent. (First Middle Last)
listingAgentPhone
string
The preferred phone number of the listing agent.
listingOfficeName
string
The office name associated with the listing agent.
listingOfficePhone
string
The office phone number associated with the listing agent.
coListingAgent
string
A system unique identifier for the co-listing agent
mlsCoListingAgentID
string
The well-known identifier for the co-Listing agent
buyerAgent
string
A system unique identifier for the buyer's agent
mlsBuyerAgentID
string
The well-known identifier for the buyer's agent
coBuyerAgent
string
A system unique identifier for the co-buyer's agent
mlsCoBuyerAgentID
string
The well-known identifier for the co-buyer's agent
listingAgreement
string
The nature of the agreement between the seller and the listing agent
listingTerms
[string]
Terms of the listing such as Lien Release, Subject to Court Approval or Owner Will Carrys
address
string
Complete address for the listing property.
coordinates
[number]
The longitude and latitude associated with the property in the listing.
url
string
URL to find details for the specific listing.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/listings?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "1dbc1d8dacc8bf449c8c0f568592dcae",
      "mlsListingID": "c3f5f730b87a02e2cb1a118b0ec892e0",
      "address": "212 Church Street, San Francisco, CA",
      "streetName": "Street St.",
      "streetNumber": "123",
      "city": "San Francisco",
      "state": "CA",
      "county": "San Francisco",
      "country": "USA",
      "zipCode": "94114",
      "subdivision": "Et ipsam ex voluptates. Nihil ab eos odio aperiam commodi sequi impedit veritatis. Dicta adipisci dolores veritatis in voluptatem mollitia.",
      "listDate": "2016-01-05T23:52:08.858Z",
      "lastModified": "2016-01-05T23:52:08.858Z",
      "price": 985033,
      "previousPrice": 960776,
      "originalPrice": 529850,
      "closePrice": 176132,
      "contingency": "Et eveniet et.",
      "unitsInBuilding": 58,
      "cancelationDate": null,
      "expirationDate": null,
      "dateListed": "2016-01-05T23:52:08.858Z",
      "dateSold": "2016-01-05T23:52:08.858Z",
      "statusChange": "2016-01-05T23:52:08.858Z",
      "ownership": "Sole P",
      "financialDataSource": "Plumbing Issues,Kitchen Water Leakage,Termites,Foundation Cracks",
      "yearBuilt": 1969,
      "yearBuiltDetails": "Eveniet enim aut.",
      "daysOnMarket": 191,
      "waterfront": true,
      "zoning": "C-2",
      "zoningDescription": "Rezone Possible",
      "acres": 2,
      "livingArea": 1370,
      "aboveGradeFinishedArea": 1372,
      "belowGradeFinishedArea": 1341,
      "stories": 2,
      "storiesTotal": 2,
      "baths": 2,
      "halfBaths": 3,
      "bedrooms": 4,
      "roomsTotal": 21,
      "fireplaces": 2,
      "frontageLength": 264,
      "additionalParcels": true,
      "occupantType": "Owner",
      "garageSpaces": 2,
      "pool": true,
      "poolPrivate": false,
      "roof": "Metal",
      "carportSpaces": 2,
      "status": "Active",
      "type": "Residential",
      "subtype": "Townhouse",
      "publicRemarks": "Atque inventore et voluptatem. Aut minima sit cum sed. Molestiae sunt qui sunt odio inventore.\n \r\tDolores ad quis aliquam. A nisi doloremque officiis qui quia.\n \r\tBeatae nisi at nemo quidem voluptatem ducimus.\n \r\tQuia ut dolorem eaque. Sunt odio eos sunt in odit atque. Sit quam ea temporibus beatae dolorem provident quia.",
      "privateRemarks": "Aperiam nihil reiciendis autem alias molestiae quia at. Perferendis praesentium autem quia et eligendi doloremque quos. Esse dolores et ut culpa exercitationem maxime nemo.\n \r\tOptio dolorum quis quasi modi provident. Non animi officiis qui eveniet neque odio. Et deleniti soluta recusandae quis et veritatis.\n \r\tNon quia qui quam rerum.\n \r\tIn aut consequatur laudantium.",
      "taxAssessedValue": 245470,
      "taxAnnual": 270432,
      "taxYear": 2016,
      "vendorID": "testapproval",
      "taxStatus": [],
      "media": [
        {
          "index": 0,
          "mimeType": "image/jpeg",
          "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
          "id": "7e6a4d6d687ff7f859730a961ab9d01e"
        },
        {
          "index": 1,
          "mimeType": "image/jpeg",
          "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
          "id": "67e074573a83bd0f275c68d2a91820f4"
        },
        {
          "index": 2,
          "mimeType": "image/jpeg",
          "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
          "id": "8de89bd8908a5ec52b8b62f9f5ea21a1"
        },
        {
          "index": 3,
          "mimeType": "image/jpeg",
          "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
          "id": "62c4754c998a6b4f45a8bad8c624b365"
        },
        {
          "index": 4,
          "mimeType": "image/jpeg",
          "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
          "id": "988f2b6f217aa66f787e5de98fba949c"
        }
      ],
      "laundry": [
        "In Kitchen"
      ],
      "sewer": [
        "Yes Connected"
      ],
      "constructionMaterials": [
        "Brick",
        "Wood"
      ],
      "roadSurface": [
        "Gravel",
        "Rock",
        "Dirt",
        "Granite"
      ],
      "possession": [
        "COE"
      ],
      "poolFeatures": [],
      "heating": [
        "Forced Air",
        "Heat Pump",
        "2 or more Heat Sources",
        "Space Heater"
      ],
      "cooling": [
        "Evaporative Cooler",
        "Ceiling Fan"
      ],
      "accessibilityFeatures": null,
      "gas": null,
      "foundationDetails": [
        "Strip",
        "Pad",
        "Grillage",
        "Mat",
        "Pile"
      ],
      "flooring": null,
      "exteriorFeatures": null,
      "fireplaceFeatures": null,
      "waterSource": [
        "Municipal",
        "Irrigation District",
        "Private Utility"
      ],
      "view": null,
      "telephoneService": [
        "Available"
      ],
      "appliances": [
        "Breakfast Bar",
        "Dishwasher",
        "Disposal",
        "Double Oven",
        "Oven",
        "Microwave",
        "Oven/Range Built-In",
        "Pantry"
      ],
      "termsOfSale": [
        "None"
      ],
      "disclosures": [
        "Plumbing Issues",
        "Kitchen Water Leakage",
        "Termites",
        "Foundation Cracks"
      ],
      "coordinates": [
        -122.428913,
        37.767348
      ],
      "mlsOfficeID": "5d2e3e5d20da07ca8a2f340c18daac17",
      "office": "a87952c05bdbc45c849aaa0539aed3ca",
      "agent": "3854d0b871a0c7402b498419d8860a73",
      "mlsAgentID": "e50d6a9199b9bcf85115b7c2f656e242",
      "url": "https://rets.io/api/v1/test/listings/1dbc1d8dacc8bf449c8c0f568592dcae"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/listings
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/listings/maps

Description

Retrieves map coordinates for listings. Allows for high limit queries as high as 10,000


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).

Response

Name
Type
Description
coordinates
[number]
The longitude and latitude associated with the property in the listing.
id
string
Unique ID generated by Retsly to identify the listing.
url
string
URL to find details for the specific listing.

Example Code

Example URL
https://rets.io/api/v1/test/listings/maps?access_token=6baca547742c6f96a6ff71b138424f21&limit=5
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "d34eabb195deee3b55493d47cb8a9d14",
      "coordinates": [
        -122.428913,
        37.767348
      ],
      "url": "https://dev.rets.io/api/v1/test/listings/d34eabb195deee3b55493d47cb8a9d14"
    },
    {
      "id": "22e5523d6e5a898fd61e82b24259586c",
      "coordinates": [
        -122.401433,
        37.774335
      ],
      "url": "https://dev.rets.io/api/v1/test/listings/22e5523d6e5a898fd61e82b24259586c"
    },
    {
      "id": "3911e54a59ee55487e26ed0f760b41b5",
      "coordinates": [
        -122.438039,
        37.775751
      ],
      "url": "https://dev.rets.io/api/v1/test/listings/3911e54a59ee55487e26ed0f760b41b5"
    },
    {
      "id": "1d0e788233a39da91b5097e44d74e876",
      "coordinates": [
        -122.439805,
        37.786363
      ],
      "url": "https://dev.rets.io/api/v1/test/listings/1d0e788233a39da91b5097e44d74e876"
    },
    {
      "id": "695d120c1816d2db12867631c6b0a412",
      "coordinates": [
        -122.422986,
        37.755304
      ],
      "url": "https://dev.rets.io/api/v1/test/listings/695d120c1816d2db12867631c6b0a412"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/listings/maps
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/listings/cluster

Description

Retrieves a list of geohashes and the number of listings that fall within each geohash.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
precision
number
The length (precision) of the returned geohashes. Maximum geohash precision is 6.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).

Response

Name
Type
Description
clusters.key
string
Alphanumeric string that represents a location and maps to longitude and latitude coordinates. The precision is determined by the length of the string, e.g. gb or gb7xzm.
clusters.doc_count
number
Number of listings that fall within the geohash.

Example Code

Example URL
https://rets.io/api/v1/test/listings/cluster?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "clusters": [
      {
        "key": "9mu",
        "doc_count": 1001
      },
      {
        "key": "9q9",
        "doc_count": 1
      }
    ],
    "total": 1002
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/listings/cluster
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/listings/{listingId}

Description

Retrieves a single listing.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
listingId
string
listing id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the listing.
originatingSystemKey
string
The unique identifier from the originating system which is commonly a key to that system.
originatingSystemName
string
The name of the originating record provider. Most commonly the name of the MLS.
mlsListingID
string
The well known identifier for the listing.
unitNumber
string
The unit number pertaining to apartments, etc.
streetName
string
The street name for the listing property.
streetNumber
string
The street number for the listing property.
city
string
The city which the listing property resides in.
state
string
The state which the listing property resides in.
county
string
The county with which the listing property resides in.
country
string
The country with which the listing property resides in.
zipCode
string
The postal code for the listing property.
subdivision
string
The name of the subdivision if the listing property has one.
listDate
string
The date of the agreement between the seller and the seller's broker.
lastModified
string
The date which the posted listing was last modified.
price
number
The current price of the listing property.
previousPrice
number
The last price of the listing property.
originalPrice
number
The first price of the listing property.
closePrice
number
The closing price of the listing property.
buyerFinancing
string
A list of options that describe the type of financing used.
buyerAgencyCompensation
string
The total commission to be paid for this sale, expressed as either a percentage or a constant currency amount.
concessions
string
Are there concessions included in the sales agreement?
concessionsComments
string
Comments describing the concessions made by the buyer or the seller.
concessionsAmount
number
The dollar amount of the concessions
contingency
string
A list of contingencies that must be satisfied in order to complete the transaction.
disclosures
[string]
A list of legal or pertinent information that should be disclosed to potential buyer's agents.
unitsInBuilding
number
The total number of units in the building if applicable.
cancelationDate
string
The cancelation date of the listing if applicable.
expirationDate
string
The expiration date of the listing if applicable.
dateListed
string
The date that the property was first listed.
dateSold
string
The date that the property was sold.
statusChange
string
The date that the contractual status of the listing property was changed.
developmentStatus
[string]
A list of the development status of the property.
ownership
string
A text description of the manner in which title to a property is held.
signOnProperty
boolean
Is there a sign on the property.
financialDataSource
string
A list of the rental information, e.g. Accountant, Owner, etc.
yearBuilt
number
The year which the listing property was built.
yearBuiltDetails
string
A description of the details behind the year the structure was built.
daysOnMarket
number
The number of days the listing property has been posted on the market.
model
string
The model of the mobile or manufactured home.
appliances
[string]
A list of the appliances that will be included in the sale/lease of the property.
telephoneService
[string]
A list of telephone-service related features of the property.
view
[string]
A listed description of the view as seen from the listed property.
waterfront
boolean
A boolean value indicating waterfront property.
waterfrontFeatures
[string]
The features of the waterfront on which the property is located.
waterSource
[string]
A list of the source(s) of water for the property.
zoning
string
Typically a shortcode indicating the zoning given for the lot to discern permissible land uses.
zoningDescription
string
A list of descriptions of the zoning of the property.
acres
number
The number of acres dedicated to the lot of the listed property.
squareFootage
number
The total lot size of the property given in square feet.
livingArea
number
The total livable area within the structure.
entryLevel
number
A numeric field that describes the level within the structure, SFR or a unit in a building, where the main entry to the dwelling is located
aboveGradeFinishedArea
number
The finished area within the structure that is at or above the surface of the ground.
belowGradeFinishedArea
number
The finished area within the structure that is below ground.
stories
number
The number of floors in the property being sold.
storiesTotal
number
The total number of floors in the building.
commonWalls
[string]
A list with options indicating the presence of various types of common walls/wall partitions
baths
number
The simple sum of the number of bathrooms. Two half baths and a full bathroom would be 3 total.
halfBaths
number
The number of rooms containing 2 of 4 elements constituting a bath, e.g. toilet, sink, bathtub, shower.
bedrooms
number
The total number of bedrooms in the dwelling.
roomsTotal
number
The total number of rooms within the listed property.
fireplaces
number
The total number of fireplaces within the listed property.
fireplaceFeatures
[string]
A list of features or description of the fireplace(s) included in the sale/lease.
exteriorFeatures
[string]
A list of features or description of the exterior of the property.
newConstruction
boolean
Is the property newly constructed and has not been previously occupied?
homeWarranty
boolean
Is a home warranty included in the sale of the property?
architecturalStyle
[string]
A list describing the style of the structure.
elementarySchool
string
The name of the primary school having a catchment area that includes the associated property.
middleOrJuniorSchool
string
The name of the junior or middle school having a catchment area that includes the associated property.
highSchool
string
The name of the high school having a catchment area that includes the associated property.
directions
string
Driving directions to the property.
showingInstructions
string
Remarks that detail the seller's instructions for showing the subject property
communityFeatures
[string]
A list of features related to, or available within, the community.
patioAndPorchFeatures
[string]
A list of features or description of the patio or porch included in the sale/lease.
buildingFeatures
[string]
The features or amenities of the building or business park.
interiorFeatures
[string]
A list of features or description of the interior of the property included in the sale/lease.
parkingFeatures
[string]
A list of features or description of the parking included in the sale/lease
lotFeatures
[string]
A list of features or description of the lot included in the sale/lease.
basement
[string]
A list of information and features about the basement.
otherStructures
[string]
A list of structures other than the main dwelling.
lockboxType
[string]
A field describing the type of lock box.
lockboxLocation
string
A field describing the location of the lock box.
exclusions
string
The Elements of the property that will not be included in the sale
petsAllowed
[string]
Are pets allowed at the property being leased?
flooring
[string]
A list of the type(s) of flooring found within the property.
foundationDetails
[string]
A list of the type(s) of foundation on which the property sits.
frontageLength
number
Textual description of the length of the frontages for the listed property.
gas
[string]
A list of gas-service related features of the property.
accessibilityFeatures
[string]
A list or description of the accessibility features included in the sale/lease.
cooling
[string]
A list describing the cooling or air conditioning features of the property.
heating
[string]
A list describing the heating features of the property.
parcelNumber
string
A number used to uniquely identify a parcel or lot. Can vary between county and entered without dashes or hyphens.
additionalParcels
boolean
A boolean indicating if more than one parcel or lot is included in the sale.
occupantType
string
A field that describes the type of occupant, e.g. Owner, Tenant, Vacant.
pool
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
poolFeatures
[string]
A list of features or description of the pool included in the sale/lease.
poolPrivate
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
possession
[string]
A list defining when the possession will occur.
roadSurface
[string]
A list of types of surface of the road to access the property.
roof
[string]
A list describing the type or style of roof.
constructionMaterials
[string]
A list of materials that were used in the construction of the property.
sewer
[string]
A list describing the sewer or septic features of the property.
waterSewerExpense
number
The annual water and sewage sexpense that is not paid directly by the tenant and is included in the Operating Expense calculations.
garageSpaces
number
The number of spaces in the garage if applicable.
carportSpaces
number
The number of spaces in the carport if applicable.
openParking
boolean
A boolean indicating if there is open space parking.
attachedGarage
boolean
A flag indicating that the garage is attached to the dwelling.
carport
boolean
A flag indicating that the listing has a garage.
laundry
[string]
List of features and locations where the laundry is located in the property.
type
string
A list of types of properties such as Residential, Lease, Income, Land, Mobile, etc.
subtype
string
A list of types of residential and residential lease properties, e.g. SFR, Condo, etc.
publicRemarks
string
Text remarks that may be displayed to the public.
privateRemarks
string
Remarks that may contain security or proprietary information that should be restricted from public view.
agent
string
An ID used by Retsly to reference the agent associated with the listing.
mlsAgentID
string
A listing specific realtor's MLS ID number.
office
string
An ID used by Retsly to reference the office associated with the listing agent.
mlsOfficeID
string
A listing specific office's MLS ID number.
status
string
Local or regional MLS status.
contractStatusChangeDate
string
The date of the listings contractual status change.
contingentDate
string
The date an offer was made with a contingency.
withdrawnDate
string
Date the listing was withdrawn from the market.
offMarketDate
string
The date the listing was taken off market.
purchaseContractDate
string
With for-sale listings, the date an offer was accepted and the listing was no longer on market.
originalEntryTimestamp
string
The timestamp recorded by the MLS system representing the date/time the listing was entered.
taxAssessedValue
number
The property value as of the last assessment by the taxing authority.
taxAnnual
number
The annual property tax amount as of the last assessment made by the taxing authority.
taxYear
number
The year in which the last assessment of the property value/tax was made.
taxStatus
[string]
A list of the current tax statuses of the mobile home in cases where the land is included in the sale.
association
boolean
Is there a Home Owners Association.
associationName
string
The name of the Home Owners Association.
associationFee
number
A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common area, neighborhood or other association related benefits.
associationFeeFrequency
string
The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc.
associationFeeIncludes
[string]
Services included with the association fee. For example Landscaping, Trash, Water, etc
listingAgentFirstName
string
The first name of the listing agent.
listingAgentLastName
string
The last name of the listing agent.
listingAgentMiddleName
string
The middle name of the listing agent.
listingAgentFullName
string
The full name of the listing agent. (First Middle Last)
listingAgentPhone
string
The preferred phone number of the listing agent.
listingOfficeName
string
The office name associated with the listing agent.
listingOfficePhone
string
The office phone number associated with the listing agent.
coListingAgent
string
A system unique identifier for the co-listing agent
mlsCoListingAgentID
string
The well-known identifier for the co-Listing agent
buyerAgent
string
A system unique identifier for the buyer's agent
mlsBuyerAgentID
string
The well-known identifier for the buyer's agent
coBuyerAgent
string
A system unique identifier for the co-buyer's agent
mlsCoBuyerAgentID
string
The well-known identifier for the co-buyer's agent
listingAgreement
string
The nature of the agreement between the seller and the listing agent
listingTerms
[string]
Terms of the listing such as Lien Release, Subject to Court Approval or Owner Will Carrys
address
string
Complete address for the listing property.
coordinates
[number]
The longitude and latitude associated with the property in the listing.
url
string
URL to find details for the specific listing.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/listings/e98b11e1c2d285e4e72d90715cce4eda?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "agent": "8c470ebbbe4937587a3ac4b9080fe7d8",
    "id": "e98b11e1c2d285e4e72d90715cce4eda",
    "mlsListingID": "7bfff7da730535fa9047055d9b6e3301",
    "address": "1101 T Street, Sacramento, CA",
    "streetName": "Street St.",
    "streetNumber": "123",
    "city": "Sacramento",
    "state": "CA",
    "county": "Sacramento",
    "country": "USA",
    "zipCode": "95811-6503",
    "subdivision": "Dolor qui enim eaque quae quaerat architecto at. Quia quisquam autem dignissimos ut sit. Inventore veritatis odio aut et laboriosam culpa.",
    "listDate": "2016-01-05T23:52:06.658Z",
    "lastModified": "2016-01-05T23:52:06.658Z",
    "price": 250671,
    "previousPrice": 495305,
    "originalPrice": 246254,
    "closePrice": 772770,
    "contingency": "Sunt nostrum placeat repudiandae labore. Amet placeat et rerum nesciunt ab sunt autem quae. Et quod animi quia aut consequatur consequatur sed.",
    "unitsInBuilding": 28,
    "cancelationDate": "2016-01-05T23:52:06.659Z",
    "expirationDate": null,
    "dateListed": "2016-01-05T23:52:06.658Z",
    "dateSold": "2016-01-05T23:52:06.658Z",
    "statusChange": "2016-01-05T23:52:06.658Z",
    "ownership": "Sole P",
    "financialDataSource": "",
    "yearBuilt": 1982,
    "yearBuiltDetails": "Est error id. Enim non similique ab nostrum ut. Nesciunt tempora numquam dignissimos omnis vitae totam temporibus molestiae.",
    "daysOnMarket": 253,
    "waterfront": true,
    "zoning": "AE",
    "zoningDescription": "Agricultural",
    "acres": 3,
    "livingArea": 4853,
    "aboveGradeFinishedArea": 3454,
    "belowGradeFinishedArea": 4868,
    "stories": 2,
    "storiesTotal": 9,
    "baths": 4,
    "halfBaths": 1,
    "bedrooms": 1,
    "roomsTotal": 22,
    "fireplaces": 4,
    "frontageLength": 878,
    "additionalParcels": false,
    "occupantType": "Owner",
    "garageSpaces": 1,
    "pool": true,
    "poolPrivate": true,
    "roof": "Metal,Gravel",
    "carportSpaces": 1,
    "status": "Canceled",
    "type": "Business",
    "subtype": "Duplex",
    "publicRemarks": "Quia porro ut perferendis sit ut.\n \r\tQuo laborum aperiam sit. Qui quia sit voluptate magnam a quo dolore.\n \r\tAmet magnam dolorem et odio. Fuga nihil officia ea alias. Consequuntur soluta minima aliquid omnis nihil odit eos eligendi.\n \r\tConsequuntur explicabo assumenda doloribus sit est qui inventore mollitia.",
    "privateRemarks": "Et ipsam minima. Accusantium nisi accusamus vitae quia ad ipsum repellendus. Magnam nostrum illum et explicabo ad accusamus cum vel.\n \r\tAspernatur voluptatibus modi quis consequuntur animi unde eaque nesciunt. Impedit adipisci enim aut.\n \r\tOdit nemo labore rerum tempora officiis eaque. Eum rerum qui repellendus est totam minus quis nihil.\n \r\tModi aut omnis aut ut.",
    "taxAssessedValue": 933278,
    "taxAnnual": 515023,
    "taxYear": 2016,
    "vendorID": "testapproval",
    "taxStatus": [],
    "media": [
      {
        "index": 0,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "04f83b29c4603894eef64aff186239ff"
      },
      {
        "index": 1,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
        "id": "59fcf81915998dbb722c7deb290daa53"
      },
      {
        "index": 2,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "685de62f2751fa6da8664d02a9368318"
      },
      {
        "index": 3,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
        "id": "b6179675ad89396170f9dfb70c81340f"
      },
      {
        "index": 4,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "704c152625fcc31d066a24ad09b0690b"
      },
      {
        "index": 5,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
        "id": "37e562503517b7d6c690935c69db2676"
      },
      {
        "index": 6,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "23e6176f6dd7a310d904e2b67e1773b0"
      },
      {
        "index": 7,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
        "id": "585e09c564564438304de1476fee43cf"
      }
    ],
    "laundry": [
      "In Kitchen",
      "Gas Dryer Hookup",
      "Washer"
    ],
    "sewer": [
      "Yes Connected"
    ],
    "constructionMaterials": [],
    "roadSurface": [
      "Gravel"
    ],
    "possession": [
      "COE+1"
    ],
    "poolFeatures": [
      "In-ground",
      "Out of ground"
    ],
    "heating": [
      "Forced Air",
      "Heat Pump"
    ],
    "cooling": [
      "Evaporative Cooler"
    ],
    "accessibilityFeatures": null,
    "gas": [],
    "foundationDetails": [
      "Strip",
      "Pad",
      "Grillage"
    ],
    "flooring": [
      "Hardwood",
      "Laminate"
    ],
    "exteriorFeatures": [],
    "fireplaceFeatures": null,
    "waterSource": [
      "Municipal"
    ],
    "view": [
      "Lake View",
      "Ocean View"
    ],
    "telephoneService": [
      "Installed"
    ],
    "appliances": [
      "Breakfast Bar",
      "Dishwasher",
      "Disposal",
      "Double Oven",
      "Oven",
      "Microwave",
      "Oven/Range Built-In",
      "Pantry"
    ],
    "termsOfSale": [
      "None"
    ],
    "disclosures": [
      "Plumbing Issues"
    ],
    "coordinates": [
      -121.496549,
      38.569085
    ],
    "mlsOfficeID": "438ee1a521b080ba6bf0bf63a2703342",
    "office": "65330e2651d48980d04c52c00e65872f",
    "mlsAgentID": "df475ddb43ddc92b7db0b103e3a52402",
    "url": "https://rets.io/api/v1/test/listings/e98b11e1c2d285e4e72d90715cce4eda"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/listings/{listingId}
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/listings/{listingId}/agent

Description

Retrieves the listing agent associated with a listing.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
listingId
string
listing id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the agent.
mlsMemberID
string
A specific realtor's MLS identifier, may be the same as mlsAgentID.
mlsAgentID
string
The MLS's unique system ID number for a specific realtor.
firstName
string
The first name of the listing agent.
lastName
string
The last name of the listing agent.
middleName
string
The middle name of the listing agent.
fullName
string
The full name of the listing agent.
title
string
The title of the listing agent, i.e. Mr., Mrs., Ms., Dr., etc.
cellPhone
string
The cell phone number of the listing agent.
homePhone
string
The home phone number of the listing agent.
stateLicense
string
The state in which the agent is licensed.
address
string
The street number, direction, name and suffix of the agent.
city
string
The city of the agent.
state
string
The state or province in which the agent is addressed.
zipCode
string
The postal code of the agent.
office
string
An ID used by Retsly to reference the office associated with the agent.
mlsOfficeID
string
A specific office's MLS ID number associated with the agent.
officePhone
string
The office phone number associated with the agent.
officeName
string
The office name associated with the agent.
status
string
The status of the agent's MLS account, i.e. active, inactive, under disciplinary action.
type
string
The type of agent, i.e. Agent, Broker, Office Manager, Appraiser, Photographer, Assistants, MLO, Realtor, Association Staff, MLS Staff, etc.
lastModified
string
The date which the agent was last modified.
url
string
URL to find details for the specific agent.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/listings/e98b11e1c2d285e4e72d90715cce4eda/agent?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "id": "8c470ebbbe4937587a3ac4b9080fe7d8",
    "mlsAgentID": "df475ddb43ddc92b7db0b103e3a52402",
    "firstName": "Elliot",
    "lastName": "Lowe",
    "fullName": "Elliot Lowe",
    "cellPhone": "959",
    "homePhone": "050",
    "officePhone": "",
    "title": "Dr.",
    "office": "86bc7a43aa6cd4aee0aeb693ea419667",
    "mlsOfficeID": "7ecd80badcc501c85dc59a0a112827e0",
    "status": "Active",
    "media": [],
    "url": "https://rets.io/api/v1/test/listings/8c470ebbbe4937587a3ac4b9080fe7d8"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/listings/{listingId}/agent
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/listings/{listingId}/office

Description

Retrieves an office associated with a listing.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
listingId
string
listing id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the office.
mlsOfficeID
string
A specific office's MLS ID number.
type
string
The type of business conducted by the office, i.e. Association, MLS, Realtor Firm, etc.
address
string
The address associated to the office.
city
string
The city in which the office is located.
state
string
The state that the office resides in.
zipCode
string
The zip code of the office.
phone
string
The phone number of the office.
fax
string
The office's fax number.
name
string
The name of the office.
status
string
The status of the office, i.e. active, inactive, under disciplinary action.
url
string
URL to find details for the specific office.
lastModified
string
The date which the record was last modified.

Example Code

Example URL
https://rets.io/api/v1/test/listings/e98b11e1c2d285e4e72d90715cce4eda/office?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "name": "Block-McLaughlin Realty",
    "fax": "",
    "phone": "18",
    "address": "50150 Darrell Creek",
    "zipCode": "",
    "city": "Sipeschester",
    "state": "GU",
    "id": "65330e2651d48980d04c52c00e65872f",
    "mlsOfficeID": "438ee1a521b080ba6bf0bf63a2703342",
    "status": "Active",
    "url": "https://rets.io/api/v1/test/listings/65330e2651d48980d04c52c00e65872f"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/listings/{listingId}/office
Getting Response
Response Status
Response Body
Your Response Here

/agents

GET

/{dataset}/agents

Description

Retrieves a set of agents.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the agent.
mlsMemberID
string
A specific realtor's MLS identifier, may be the same as mlsAgentID.
mlsAgentID
string
The MLS's unique system ID number for a specific realtor.
firstName
string
The first name of the listing agent.
lastName
string
The last name of the listing agent.
middleName
string
The middle name of the listing agent.
fullName
string
The full name of the listing agent.
title
string
The title of the listing agent, i.e. Mr., Mrs., Ms., Dr., etc.
cellPhone
string
The cell phone number of the listing agent.
homePhone
string
The home phone number of the listing agent.
stateLicense
string
The state in which the agent is licensed.
address
string
The street number, direction, name and suffix of the agent.
city
string
The city of the agent.
state
string
The state or province in which the agent is addressed.
zipCode
string
The postal code of the agent.
office
string
An ID used by Retsly to reference the office associated with the agent.
mlsOfficeID
string
A specific office's MLS ID number associated with the agent.
officePhone
string
The office phone number associated with the agent.
officeName
string
The office name associated with the agent.
status
string
The status of the agent's MLS account, i.e. active, inactive, under disciplinary action.
type
string
The type of agent, i.e. Agent, Broker, Office Manager, Appraiser, Photographer, Assistants, MLO, Realtor, Association Staff, MLS Staff, etc.
lastModified
string
The date which the agent was last modified.
url
string
URL to find details for the specific agent.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/agents?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "12cb9f9379896c2a2c24ba3c0fb22a67",
      "mlsAgentID": "ed4895d44594dd829d329f73803ed86d",
      "firstName": "Aniyah",
      "lastName": "Mitchell",
      "fullName": "Aniyah Mitchell",
      "cellPhone": "41037",
      "homePhone": "35",
      "officePhone": "59",
      "title": "Miss",
      "office": "e15b3d8c09e583a04d123872318096c8",
      "mlsOfficeID": null,
      "status": "Inactive",
      "media": [],
      "url": "https://rets.io/api/v1/test/agents/12cb9f9379896c2a2c24ba3c0fb22a67"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/agents
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/agents/{agentId}

Description

Retrieves a single agent.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
agentId
string
agentId

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the agent.
mlsMemberID
string
A specific realtor's MLS identifier, may be the same as mlsAgentID.
mlsAgentID
string
The MLS's unique system ID number for a specific realtor.
firstName
string
The first name of the listing agent.
lastName
string
The last name of the listing agent.
middleName
string
The middle name of the listing agent.
fullName
string
The full name of the listing agent.
title
string
The title of the listing agent, i.e. Mr., Mrs., Ms., Dr., etc.
cellPhone
string
The cell phone number of the listing agent.
homePhone
string
The home phone number of the listing agent.
stateLicense
string
The state in which the agent is licensed.
address
string
The street number, direction, name and suffix of the agent.
city
string
The city of the agent.
state
string
The state or province in which the agent is addressed.
zipCode
string
The postal code of the agent.
office
string
An ID used by Retsly to reference the office associated with the agent.
mlsOfficeID
string
A specific office's MLS ID number associated with the agent.
officePhone
string
The office phone number associated with the agent.
officeName
string
The office name associated with the agent.
status
string
The status of the agent's MLS account, i.e. active, inactive, under disciplinary action.
type
string
The type of agent, i.e. Agent, Broker, Office Manager, Appraiser, Photographer, Assistants, MLO, Realtor, Association Staff, MLS Staff, etc.
lastModified
string
The date which the agent was last modified.
url
string
URL to find details for the specific agent.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/agents/12cb9f9379896c2a2c24ba3c0fb22a67?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "id": "12cb9f9379896c2a2c24ba3c0fb22a67",
    "mlsAgentID": "ed4895d44594dd829d329f73803ed86d",
    "firstName": "Aniyah",
    "lastName": "Mitchell",
    "fullName": "Aniyah Mitchell",
    "cellPhone": "41037",
    "homePhone": "35",
    "officePhone": "59",
    "title": "Miss",
    "office": "e15b3d8c09e583a04d123872318096c8",
    "mlsOfficeID": null,
    "status": "Inactive",
    "media": [],
    "url": "https://rets.io/api/v1/test/agents/12cb9f9379896c2a2c24ba3c0fb22a67"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/agents/{agentId}
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/agents/{agentId}/listings

Description

Retrieves the listings associated with a listing agent.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
agentId
string
agentId

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the listing.
originatingSystemKey
string
The unique identifier from the originating system which is commonly a key to that system.
originatingSystemName
string
The name of the originating record provider. Most commonly the name of the MLS.
mlsListingID
string
The well known identifier for the listing.
unitNumber
string
The unit number pertaining to apartments, etc.
streetName
string
The street name for the listing property.
streetNumber
string
The street number for the listing property.
city
string
The city which the listing property resides in.
state
string
The state which the listing property resides in.
county
string
The county with which the listing property resides in.
country
string
The country with which the listing property resides in.
zipCode
string
The postal code for the listing property.
subdivision
string
The name of the subdivision if the listing property has one.
listDate
string
The date of the agreement between the seller and the seller's broker.
lastModified
string
The date which the posted listing was last modified.
price
number
The current price of the listing property.
previousPrice
number
The last price of the listing property.
originalPrice
number
The first price of the listing property.
closePrice
number
The closing price of the listing property.
buyerFinancing
string
A list of options that describe the type of financing used.
buyerAgencyCompensation
string
The total commission to be paid for this sale, expressed as either a percentage or a constant currency amount.
concessions
string
Are there concessions included in the sales agreement?
concessionsComments
string
Comments describing the concessions made by the buyer or the seller.
concessionsAmount
number
The dollar amount of the concessions
contingency
string
A list of contingencies that must be satisfied in order to complete the transaction.
disclosures
[string]
A list of legal or pertinent information that should be disclosed to potential buyer's agents.
unitsInBuilding
number
The total number of units in the building if applicable.
cancelationDate
string
The cancelation date of the listing if applicable.
expirationDate
string
The expiration date of the listing if applicable.
dateListed
string
The date that the property was first listed.
dateSold
string
The date that the property was sold.
statusChange
string
The date that the contractual status of the listing property was changed.
developmentStatus
[string]
A list of the development status of the property.
ownership
string
A text description of the manner in which title to a property is held.
signOnProperty
boolean
Is there a sign on the property.
financialDataSource
string
A list of the rental information, e.g. Accountant, Owner, etc.
yearBuilt
number
The year which the listing property was built.
yearBuiltDetails
string
A description of the details behind the year the structure was built.
daysOnMarket
number
The number of days the listing property has been posted on the market.
model
string
The model of the mobile or manufactured home.
appliances
[string]
A list of the appliances that will be included in the sale/lease of the property.
telephoneService
[string]
A list of telephone-service related features of the property.
view
[string]
A listed description of the view as seen from the listed property.
waterfront
boolean
A boolean value indicating waterfront property.
waterfrontFeatures
[string]
The features of the waterfront on which the property is located.
waterSource
[string]
A list of the source(s) of water for the property.
zoning
string
Typically a shortcode indicating the zoning given for the lot to discern permissible land uses.
zoningDescription
string
A list of descriptions of the zoning of the property.
acres
number
The number of acres dedicated to the lot of the listed property.
squareFootage
number
The total lot size of the property given in square feet.
livingArea
number
The total livable area within the structure.
entryLevel
number
A numeric field that describes the level within the structure, SFR or a unit in a building, where the main entry to the dwelling is located
aboveGradeFinishedArea
number
The finished area within the structure that is at or above the surface of the ground.
belowGradeFinishedArea
number
The finished area within the structure that is below ground.
stories
number
The number of floors in the property being sold.
storiesTotal
number
The total number of floors in the building.
commonWalls
[string]
A list with options indicating the presence of various types of common walls/wall partitions
baths
number
The simple sum of the number of bathrooms. Two half baths and a full bathroom would be 3 total.
halfBaths
number
The number of rooms containing 2 of 4 elements constituting a bath, e.g. toilet, sink, bathtub, shower.
bedrooms
number
The total number of bedrooms in the dwelling.
roomsTotal
number
The total number of rooms within the listed property.
fireplaces
number
The total number of fireplaces within the listed property.
fireplaceFeatures
[string]
A list of features or description of the fireplace(s) included in the sale/lease.
exteriorFeatures
[string]
A list of features or description of the exterior of the property.
newConstruction
boolean
Is the property newly constructed and has not been previously occupied?
homeWarranty
boolean
Is a home warranty included in the sale of the property?
architecturalStyle
[string]
A list describing the style of the structure.
elementarySchool
string
The name of the primary school having a catchment area that includes the associated property.
middleOrJuniorSchool
string
The name of the junior or middle school having a catchment area that includes the associated property.
highSchool
string
The name of the high school having a catchment area that includes the associated property.
directions
string
Driving directions to the property.
showingInstructions
string
Remarks that detail the seller's instructions for showing the subject property
communityFeatures
[string]
A list of features related to, or available within, the community.
patioAndPorchFeatures
[string]
A list of features or description of the patio or porch included in the sale/lease.
buildingFeatures
[string]
The features or amenities of the building or business park.
interiorFeatures
[string]
A list of features or description of the interior of the property included in the sale/lease.
parkingFeatures
[string]
A list of features or description of the parking included in the sale/lease
lotFeatures
[string]
A list of features or description of the lot included in the sale/lease.
basement
[string]
A list of information and features about the basement.
otherStructures
[string]
A list of structures other than the main dwelling.
lockboxType
[string]
A field describing the type of lock box.
lockboxLocation
string
A field describing the location of the lock box.
exclusions
string
The Elements of the property that will not be included in the sale
petsAllowed
[string]
Are pets allowed at the property being leased?
flooring
[string]
A list of the type(s) of flooring found within the property.
foundationDetails
[string]
A list of the type(s) of foundation on which the property sits.
frontageLength
number
Textual description of the length of the frontages for the listed property.
gas
[string]
A list of gas-service related features of the property.
accessibilityFeatures
[string]
A list or description of the accessibility features included in the sale/lease.
cooling
[string]
A list describing the cooling or air conditioning features of the property.
heating
[string]
A list describing the heating features of the property.
parcelNumber
string
A number used to uniquely identify a parcel or lot. Can vary between county and entered without dashes or hyphens.
additionalParcels
boolean
A boolean indicating if more than one parcel or lot is included in the sale.
occupantType
string
A field that describes the type of occupant, e.g. Owner, Tenant, Vacant.
pool
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
poolFeatures
[string]
A list of features or description of the pool included in the sale/lease.
poolPrivate
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
possession
[string]
A list defining when the possession will occur.
roadSurface
[string]
A list of types of surface of the road to access the property.
roof
[string]
A list describing the type or style of roof.
constructionMaterials
[string]
A list of materials that were used in the construction of the property.
sewer
[string]
A list describing the sewer or septic features of the property.
waterSewerExpense
number
The annual water and sewage sexpense that is not paid directly by the tenant and is included in the Operating Expense calculations.
garageSpaces
number
The number of spaces in the garage if applicable.
carportSpaces
number
The number of spaces in the carport if applicable.
openParking
boolean
A boolean indicating if there is open space parking.
attachedGarage
boolean
A flag indicating that the garage is attached to the dwelling.
carport
boolean
A flag indicating that the listing has a garage.
laundry
[string]
List of features and locations where the laundry is located in the property.
type
string
A list of types of properties such as Residential, Lease, Income, Land, Mobile, etc.
subtype
string
A list of types of residential and residential lease properties, e.g. SFR, Condo, etc.
publicRemarks
string
Text remarks that may be displayed to the public.
privateRemarks
string
Remarks that may contain security or proprietary information that should be restricted from public view.
agent
string
An ID used by Retsly to reference the agent associated with the listing.
mlsAgentID
string
A listing specific realtor's MLS ID number.
office
string
An ID used by Retsly to reference the office associated with the listing agent.
mlsOfficeID
string
A listing specific office's MLS ID number.
status
string
Local or regional MLS status.
contractStatusChangeDate
string
The date of the listings contractual status change.
contingentDate
string
The date an offer was made with a contingency.
withdrawnDate
string
Date the listing was withdrawn from the market.
offMarketDate
string
The date the listing was taken off market.
purchaseContractDate
string
With for-sale listings, the date an offer was accepted and the listing was no longer on market.
originalEntryTimestamp
string
The timestamp recorded by the MLS system representing the date/time the listing was entered.
taxAssessedValue
number
The property value as of the last assessment by the taxing authority.
taxAnnual
number
The annual property tax amount as of the last assessment made by the taxing authority.
taxYear
number
The year in which the last assessment of the property value/tax was made.
taxStatus
[string]
A list of the current tax statuses of the mobile home in cases where the land is included in the sale.
association
boolean
Is there a Home Owners Association.
associationName
string
The name of the Home Owners Association.
associationFee
number
A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common area, neighborhood or other association related benefits.
associationFeeFrequency
string
The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc.
associationFeeIncludes
[string]
Services included with the association fee. For example Landscaping, Trash, Water, etc
listingAgentFirstName
string
The first name of the listing agent.
listingAgentLastName
string
The last name of the listing agent.
listingAgentMiddleName
string
The middle name of the listing agent.
listingAgentFullName
string
The full name of the listing agent. (First Middle Last)
listingAgentPhone
string
The preferred phone number of the listing agent.
listingOfficeName
string
The office name associated with the listing agent.
listingOfficePhone
string
The office phone number associated with the listing agent.
coListingAgent
string
A system unique identifier for the co-listing agent
mlsCoListingAgentID
string
The well-known identifier for the co-Listing agent
buyerAgent
string
A system unique identifier for the buyer's agent
mlsBuyerAgentID
string
The well-known identifier for the buyer's agent
coBuyerAgent
string
A system unique identifier for the co-buyer's agent
mlsCoBuyerAgentID
string
The well-known identifier for the co-buyer's agent
listingAgreement
string
The nature of the agreement between the seller and the listing agent
listingTerms
[string]
Terms of the listing such as Lien Release, Subject to Court Approval or Owner Will Carrys
address
string
Complete address for the listing property.
coordinates
[number]
The longitude and latitude associated with the property in the listing.
url
string
URL to find details for the specific listing.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/agents/12cb9f9379896c2a2c24ba3c0fb22a67/listings?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "id": "12cb9f9379896c2a2c24ba3c0fb22a67",
    "mlsAgentID": "ed4895d44594dd829d329f73803ed86d",
    "firstName": "Aniyah",
    "lastName": "Mitchell",
    "fullName": "Aniyah Mitchell",
    "cellPhone": "41037",
    "homePhone": "35",
    "officePhone": "59",
    "title": "Miss",
    "office": "e15b3d8c09e583a04d123872318096c8",
    "mlsOfficeID": null,
    "status": "Inactive",
    "media": [],
    "listings": [],
    "url": "https://rets.io/api/v1/test/agents/12cb9f9379896c2a2c24ba3c0fb22a67"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/agents/{agentId}/listings
Getting Response
Response Status
Response Body
Your Response Here

/offices

GET

/{dataset}/offices

Description

Retrieves a set of offices.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the office.
mlsOfficeID
string
A specific office's MLS ID number.
type
string
The type of business conducted by the office, i.e. Association, MLS, Realtor Firm, etc.
address
string
The address associated to the office.
city
string
The city in which the office is located.
state
string
The state that the office resides in.
zipCode
string
The zip code of the office.
phone
string
The phone number of the office.
fax
string
The office's fax number.
name
string
The name of the office.
status
string
The status of the office, i.e. active, inactive, under disciplinary action.
url
string
URL to find details for the specific office.
lastModified
string
The date which the record was last modified.

Example Code

Example URL
https://rets.io/api/v1/test/offices?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "name": "Stokes-Wilkinson Realty",
      "fax": "8489",
      "phone": "",
      "address": "5165 Jeromy Way",
      "zipCode": "",
      "city": "Port Einar",
      "state": "NY",
      "id": "e15b3d8c09e583a04d123872318096c8",
      "mlsOfficeID": "1bd7d513503666304cf84260138cb3e0",
      "status": "Active",
      "url": "https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/offices
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/offices/{officeId}

Description

Retrieves a single office.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
officeId
string
office id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the office.
mlsOfficeID
string
A specific office's MLS ID number.
type
string
The type of business conducted by the office, i.e. Association, MLS, Realtor Firm, etc.
address
string
The address associated to the office.
city
string
The city in which the office is located.
state
string
The state that the office resides in.
zipCode
string
The zip code of the office.
phone
string
The phone number of the office.
fax
string
The office's fax number.
name
string
The name of the office.
status
string
The status of the office, i.e. active, inactive, under disciplinary action.
url
string
URL to find details for the specific office.
lastModified
string
The date which the record was last modified.

Example Code

Example URL
https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "name": "Stokes-Wilkinson Realty",
    "fax": "8489",
    "phone": "",
    "address": "5165 Jeromy Way",
    "zipCode": "",
    "city": "Port Einar",
    "state": "NY",
    "id": "e15b3d8c09e583a04d123872318096c8",
    "mlsOfficeID": "1bd7d513503666304cf84260138cb3e0",
    "status": "Active",
    "url": "https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/offices/{officeId}
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/offices/{officeId}/agents

Description

Retrieves a set of agents from an office.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
officeId
string
office id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the agent.
mlsMemberID
string
A specific realtor's MLS identifier, may be the same as mlsAgentID.
mlsAgentID
string
The MLS's unique system ID number for a specific realtor.
firstName
string
The first name of the listing agent.
lastName
string
The last name of the listing agent.
middleName
string
The middle name of the listing agent.
fullName
string
The full name of the listing agent.
title
string
The title of the listing agent, i.e. Mr., Mrs., Ms., Dr., etc.
cellPhone
string
The cell phone number of the listing agent.
homePhone
string
The home phone number of the listing agent.
stateLicense
string
The state in which the agent is licensed.
address
string
The street number, direction, name and suffix of the agent.
city
string
The city of the agent.
state
string
The state or province in which the agent is addressed.
zipCode
string
The postal code of the agent.
office
string
An ID used by Retsly to reference the office associated with the agent.
mlsOfficeID
string
A specific office's MLS ID number associated with the agent.
officePhone
string
The office phone number associated with the agent.
officeName
string
The office name associated with the agent.
status
string
The status of the agent's MLS account, i.e. active, inactive, under disciplinary action.
type
string
The type of agent, i.e. Agent, Broker, Office Manager, Appraiser, Photographer, Assistants, MLO, Realtor, Association Staff, MLS Staff, etc.
lastModified
string
The date which the agent was last modified.
url
string
URL to find details for the specific agent.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8/agents?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "name": "Stokes-Wilkinson Realty",
    "fax": "8489",
    "phone": "",
    "address": "5165 Jeromy Way",
    "zipCode": "",
    "city": "Port Einar",
    "state": "NY",
    "id": "e15b3d8c09e583a04d123872318096c8",
    "mlsOfficeID": "1bd7d513503666304cf84260138cb3e0",
    "status": "Active",
    "agents": [
      {
        "_id": "568c5726c151f84d29f49044",
        "id": "12cb9f9379896c2a2c24ba3c0fb22a67",
        "mlsAgentID": "ed4895d44594dd829d329f73803ed86d",
        "firstName": "Aniyah",
        "lastName": "Mitchell",
        "fullName": "Aniyah Mitchell",
        "cellPhone": "41037",
        "homePhone": "35",
        "officePhone": "59",
        "title": "Miss",
        "office": "e15b3d8c09e583a04d123872318096c8",
        "mlsOfficeID": null,
        "status": "Inactive",
        "media": [],
        "__v": 0
      }
    ],
    "url": "https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/offices/{officeId}/agents
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/offices/{officeId}/listings

Description

Retrieves a set of Listings from an office.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
officeId
string
office id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the listing.
originatingSystemKey
string
The unique identifier from the originating system which is commonly a key to that system.
originatingSystemName
string
The name of the originating record provider. Most commonly the name of the MLS.
mlsListingID
string
The well known identifier for the listing.
unitNumber
string
The unit number pertaining to apartments, etc.
streetName
string
The street name for the listing property.
streetNumber
string
The street number for the listing property.
city
string
The city which the listing property resides in.
state
string
The state which the listing property resides in.
county
string
The county with which the listing property resides in.
country
string
The country with which the listing property resides in.
zipCode
string
The postal code for the listing property.
subdivision
string
The name of the subdivision if the listing property has one.
listDate
string
The date of the agreement between the seller and the seller's broker.
lastModified
string
The date which the posted listing was last modified.
price
number
The current price of the listing property.
previousPrice
number
The last price of the listing property.
originalPrice
number
The first price of the listing property.
closePrice
number
The closing price of the listing property.
buyerFinancing
string
A list of options that describe the type of financing used.
buyerAgencyCompensation
string
The total commission to be paid for this sale, expressed as either a percentage or a constant currency amount.
concessions
string
Are there concessions included in the sales agreement?
concessionsComments
string
Comments describing the concessions made by the buyer or the seller.
concessionsAmount
number
The dollar amount of the concessions
contingency
string
A list of contingencies that must be satisfied in order to complete the transaction.
disclosures
[string]
A list of legal or pertinent information that should be disclosed to potential buyer's agents.
unitsInBuilding
number
The total number of units in the building if applicable.
cancelationDate
string
The cancelation date of the listing if applicable.
expirationDate
string
The expiration date of the listing if applicable.
dateListed
string
The date that the property was first listed.
dateSold
string
The date that the property was sold.
statusChange
string
The date that the contractual status of the listing property was changed.
developmentStatus
[string]
A list of the development status of the property.
ownership
string
A text description of the manner in which title to a property is held.
signOnProperty
boolean
Is there a sign on the property.
financialDataSource
string
A list of the rental information, e.g. Accountant, Owner, etc.
yearBuilt
number
The year which the listing property was built.
yearBuiltDetails
string
A description of the details behind the year the structure was built.
daysOnMarket
number
The number of days the listing property has been posted on the market.
model
string
The model of the mobile or manufactured home.
appliances
[string]
A list of the appliances that will be included in the sale/lease of the property.
telephoneService
[string]
A list of telephone-service related features of the property.
view
[string]
A listed description of the view as seen from the listed property.
waterfront
boolean
A boolean value indicating waterfront property.
waterfrontFeatures
[string]
The features of the waterfront on which the property is located.
waterSource
[string]
A list of the source(s) of water for the property.
zoning
string
Typically a shortcode indicating the zoning given for the lot to discern permissible land uses.
zoningDescription
string
A list of descriptions of the zoning of the property.
acres
number
The number of acres dedicated to the lot of the listed property.
squareFootage
number
The total lot size of the property given in square feet.
livingArea
number
The total livable area within the structure.
entryLevel
number
A numeric field that describes the level within the structure, SFR or a unit in a building, where the main entry to the dwelling is located
aboveGradeFinishedArea
number
The finished area within the structure that is at or above the surface of the ground.
belowGradeFinishedArea
number
The finished area within the structure that is below ground.
stories
number
The number of floors in the property being sold.
storiesTotal
number
The total number of floors in the building.
commonWalls
[string]
A list with options indicating the presence of various types of common walls/wall partitions
baths
number
The simple sum of the number of bathrooms. Two half baths and a full bathroom would be 3 total.
halfBaths
number
The number of rooms containing 2 of 4 elements constituting a bath, e.g. toilet, sink, bathtub, shower.
bedrooms
number
The total number of bedrooms in the dwelling.
roomsTotal
number
The total number of rooms within the listed property.
fireplaces
number
The total number of fireplaces within the listed property.
fireplaceFeatures
[string]
A list of features or description of the fireplace(s) included in the sale/lease.
exteriorFeatures
[string]
A list of features or description of the exterior of the property.
newConstruction
boolean
Is the property newly constructed and has not been previously occupied?
homeWarranty
boolean
Is a home warranty included in the sale of the property?
architecturalStyle
[string]
A list describing the style of the structure.
elementarySchool
string
The name of the primary school having a catchment area that includes the associated property.
middleOrJuniorSchool
string
The name of the junior or middle school having a catchment area that includes the associated property.
highSchool
string
The name of the high school having a catchment area that includes the associated property.
directions
string
Driving directions to the property.
showingInstructions
string
Remarks that detail the seller's instructions for showing the subject property
communityFeatures
[string]
A list of features related to, or available within, the community.
patioAndPorchFeatures
[string]
A list of features or description of the patio or porch included in the sale/lease.
buildingFeatures
[string]
The features or amenities of the building or business park.
interiorFeatures
[string]
A list of features or description of the interior of the property included in the sale/lease.
parkingFeatures
[string]
A list of features or description of the parking included in the sale/lease
lotFeatures
[string]
A list of features or description of the lot included in the sale/lease.
basement
[string]
A list of information and features about the basement.
otherStructures
[string]
A list of structures other than the main dwelling.
lockboxType
[string]
A field describing the type of lock box.
lockboxLocation
string
A field describing the location of the lock box.
exclusions
string
The Elements of the property that will not be included in the sale
petsAllowed
[string]
Are pets allowed at the property being leased?
flooring
[string]
A list of the type(s) of flooring found within the property.
foundationDetails
[string]
A list of the type(s) of foundation on which the property sits.
frontageLength
number
Textual description of the length of the frontages for the listed property.
gas
[string]
A list of gas-service related features of the property.
accessibilityFeatures
[string]
A list or description of the accessibility features included in the sale/lease.
cooling
[string]
A list describing the cooling or air conditioning features of the property.
heating
[string]
A list describing the heating features of the property.
parcelNumber
string
A number used to uniquely identify a parcel or lot. Can vary between county and entered without dashes or hyphens.
additionalParcels
boolean
A boolean indicating if more than one parcel or lot is included in the sale.
occupantType
string
A field that describes the type of occupant, e.g. Owner, Tenant, Vacant.
pool
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
poolFeatures
[string]
A list of features or description of the pool included in the sale/lease.
poolPrivate
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
possession
[string]
A list defining when the possession will occur.
roadSurface
[string]
A list of types of surface of the road to access the property.
roof
[string]
A list describing the type or style of roof.
constructionMaterials
[string]
A list of materials that were used in the construction of the property.
sewer
[string]
A list describing the sewer or septic features of the property.
waterSewerExpense
number
The annual water and sewage sexpense that is not paid directly by the tenant and is included in the Operating Expense calculations.
garageSpaces
number
The number of spaces in the garage if applicable.
carportSpaces
number
The number of spaces in the carport if applicable.
openParking
boolean
A boolean indicating if there is open space parking.
attachedGarage
boolean
A flag indicating that the garage is attached to the dwelling.
carport
boolean
A flag indicating that the listing has a garage.
laundry
[string]
List of features and locations where the laundry is located in the property.
type
string
A list of types of properties such as Residential, Lease, Income, Land, Mobile, etc.
subtype
string
A list of types of residential and residential lease properties, e.g. SFR, Condo, etc.
publicRemarks
string
Text remarks that may be displayed to the public.
privateRemarks
string
Remarks that may contain security or proprietary information that should be restricted from public view.
agent
string
An ID used by Retsly to reference the agent associated with the listing.
mlsAgentID
string
A listing specific realtor's MLS ID number.
office
string
An ID used by Retsly to reference the office associated with the listing agent.
mlsOfficeID
string
A listing specific office's MLS ID number.
status
string
Local or regional MLS status.
contractStatusChangeDate
string
The date of the listings contractual status change.
contingentDate
string
The date an offer was made with a contingency.
withdrawnDate
string
Date the listing was withdrawn from the market.
offMarketDate
string
The date the listing was taken off market.
purchaseContractDate
string
With for-sale listings, the date an offer was accepted and the listing was no longer on market.
originalEntryTimestamp
string
The timestamp recorded by the MLS system representing the date/time the listing was entered.
taxAssessedValue
number
The property value as of the last assessment by the taxing authority.
taxAnnual
number
The annual property tax amount as of the last assessment made by the taxing authority.
taxYear
number
The year in which the last assessment of the property value/tax was made.
taxStatus
[string]
A list of the current tax statuses of the mobile home in cases where the land is included in the sale.
association
boolean
Is there a Home Owners Association.
associationName
string
The name of the Home Owners Association.
associationFee
number
A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common area, neighborhood or other association related benefits.
associationFeeFrequency
string
The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc.
associationFeeIncludes
[string]
Services included with the association fee. For example Landscaping, Trash, Water, etc
listingAgentFirstName
string
The first name of the listing agent.
listingAgentLastName
string
The last name of the listing agent.
listingAgentMiddleName
string
The middle name of the listing agent.
listingAgentFullName
string
The full name of the listing agent. (First Middle Last)
listingAgentPhone
string
The preferred phone number of the listing agent.
listingOfficeName
string
The office name associated with the listing agent.
listingOfficePhone
string
The office phone number associated with the listing agent.
coListingAgent
string
A system unique identifier for the co-listing agent
mlsCoListingAgentID
string
The well-known identifier for the co-Listing agent
buyerAgent
string
A system unique identifier for the buyer's agent
mlsBuyerAgentID
string
The well-known identifier for the buyer's agent
coBuyerAgent
string
A system unique identifier for the co-buyer's agent
mlsCoBuyerAgentID
string
The well-known identifier for the co-buyer's agent
listingAgreement
string
The nature of the agreement between the seller and the listing agent
listingTerms
[string]
Terms of the listing such as Lien Release, Subject to Court Approval or Owner Will Carrys
address
string
Complete address for the listing property.
coordinates
[number]
The longitude and latitude associated with the property in the listing.
url
string
URL to find details for the specific listing.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8/listings?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "name": "Stokes-Wilkinson Realty",
    "fax": "8489",
    "phone": "",
    "address": "5165 Jeromy Way",
    "zipCode": "",
    "city": "Port Einar",
    "state": "NY",
    "id": "e15b3d8c09e583a04d123872318096c8",
    "mlsOfficeID": "1bd7d513503666304cf84260138cb3e0",
    "status": "Active",
    "listings": [
      {
        "_id": "568c572fc151f84d29f4ab6b",
        "id": "35276143f799f7d92c180a80c432ee70",
        "mlsListingID": "3d3438b4f1aaeb5810b7e78fb615f3bd",
        "address": "20200 Spence Road, Salinas, CA",
        "streetName": "Street St.",
        "streetNumber": "123",
        "city": "Salinas",
        "state": "CA",
        "county": "Salinas",
        "country": "USA",
        "zipCode": "93908-9507",
        "subdivision": "Consectetur ipsum rerum sint qui perferendis enim quod et.",
        "_geo": {
          "coordinates": [
            -121.547931,
            36.627641
          ],
          "type": "Point"
        },
        "listDate": "2016-01-05T23:52:15.259Z",
        "lastModified": "2016-01-05T23:52:15.259Z",
        "price": 961245,
        "previousPrice": 92010,
        "originalPrice": 928664,
        "closePrice": 232131,
        "contingency": "Voluptatum qui illo sint.",
        "unitsInBuilding": 165,
        "cancelationDate": null,
        "expirationDate": null,
        "dateListed": "2016-01-05T23:52:15.259Z",
        "dateSold": "2016-01-05T23:52:15.259Z",
        "statusChange": "2016-01-05T23:52:15.259Z",
        "ownership": "Sole P",
        "financialDataSource": "No Disclosures",
        "yearBuilt": 2012,
        "yearBuiltDetails": "Quasi esse explicabo neque.",
        "daysOnMarket": 77,
        "waterfront": false,
        "zoning": "MI",
        "zoningDescription": "Agricultural",
        "acres": 6,
        "livingArea": 3052,
        "aboveGradeFinishedArea": 935,
        "belowGradeFinishedArea": 5229,
        "stories": 2,
        "storiesTotal": 7,
        "baths": 3,
        "halfBaths": 4,
        "bedrooms": 2,
        "roomsTotal": 5,
        "fireplaces": 2,
        "frontageLength": 979,
        "additionalParcels": true,
        "occupantType": "Owner",
        "garageSpaces": 3,
        "pool": false,
        "poolPrivate": false,
        "roof": "Metal,Gravel,Composite",
        "carportSpaces": 1,
        "status": "Active",
        "type": "Business",
        "subtype": "Manufactured Home",
        "publicRemarks": "Error odio aut culpa animi minus. Et modi blanditiis facere explicabo aut.\n \r\tMolestiae qui inventore quia aspernatur eveniet. Enim est perferendis hic dignissimos enim.\n \r\tFacilis aut illum deserunt molestiae ut est. Aut est nisi harum similique id aut.\n \r\tInventore expedita quia et odio doloremque commodi accusamus.",
        "privateRemarks": "Esse et modi est impedit laudantium cum. Illo voluptas accusantium in. Quos corrupti nihil sunt placeat laudantium nemo.\n \r\tDolorum unde et enim velit ipsa eius. Soluta atque illo. Et mollitia blanditiis.\n \r\tEt ipsum natus illo aperiam accusamus. Occaecati ut et doloremque. Et molestiae assumenda iste ab est eius et.\n \r\tVeritatis autem sed corporis nemo corrupti.",
        "taxAssessedValue": 219706,
        "taxAnnual": 167894,
        "taxYear": 2016,
        "vendorID": "testapproval",
        "_address": [],
        "taxStatus": null,
        "media": [
          {
            "index": 0,
            "mimeType": "image/jpeg",
            "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
            "id": "6a07341a76da3fee8418ef1b057f6123",
            "_id": "568c572fc151f84d29f4ab68"
          },
          {
            "index": 1,
            "mimeType": "image/jpeg",
            "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
            "id": "b3420ce12f787affcf65c704b89fb420",
            "_id": "568c572fc151f84d29f4ab69"
          },
          {
            "index": 2,
            "mimeType": "image/jpeg",
            "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
            "id": "4e3844abb12302ede6e2efb92c86ecdb",
            "_id": "568c572fc151f84d29f4ab6a"
          }
        ],
        "laundry": [],
        "sewer": [
          "Yes Connected"
        ],
        "constructionMaterials": [],
        "roadSurface": [],
        "possession": null,
        "poolFeatures": null,
        "heating": [
          "Forced Air",
          "Heat Pump",
          "2 or more Heat Sources"
        ],
        "cooling": [
          "Evaporative Cooler",
          "Ceiling Fan",
          "Central Air"
        ],
        "accessibilityFeatures": [
          "Ramp",
          "Elevator",
          "Power Doors"
        ],
        "gas": [],
        "foundationDetails": [
          "Strip",
          "Pad",
          "Grillage",
          "Mat",
          "Pile"
        ],
        "flooring": [
          "Hardwood",
          "Laminate",
          "Vinyl",
          "Tiles",
          "Cork"
        ],
        "exteriorFeatures": [
          "Fenced Yard",
          "Underground Sprinkler"
        ],
        "fireplaceFeatures": null,
        "waterSource": null,
        "view": null,
        "telephoneService": [
          "Available"
        ],
        "appliances": [
          "Breakfast Bar",
          "Dishwasher",
          "Disposal",
          "Double Oven",
          "Oven"
        ],
        "termsOfSale": [
          "Survey Required",
          "Title Search"
        ],
        "disclosures": [],
        "coordinates": [
          -121.547931,
          36.627641
        ],
        "__v": 0,
        "mlsOfficeID": "1bd7d513503666304cf84260138cb3e0",
        "office": "e15b3d8c09e583a04d123872318096c8",
        "agent": "d2ab481dded46fcaddb0e6b7332ad5d1",
        "mlsAgentID": "c2762d8dd02159c7ea65e40b7c677df1"
      }
    ],
    "url": "https://rets.io/api/v1/test/offices/e15b3d8c09e583a04d123872318096c8"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/offices/{officeId}/listings
Getting Response
Response Status
Response Body
Your Response Here

/openhouses

GET

/{dataset}/openhouses

Description

Retrieves a set of openhouses.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.

Response

Name
Type
Description
agent
string
An ID used by Retsly to reference the agent associated with the open house.
mlsOpenhouseID
string
A unique identifier for this record from the immediate source.
listing
string
A generated Retsly listing ID or number that is associated with the open house.
mlsListingID
string
A unique MLS identifier for the listing associated with the open house.
mlsAgentID
string
The MLS ID of the agent who is associated with the open house.
date
string
The date on which the open house will occur.
endTime
string
The end time of the open house.
startTime
string
The start time of the open house.
type
string
The type of open house, i.e. Public, Broker, Office, Private, etc.
remarks
string
Comments, instructions or information about the open house.
status
string
Status of the open house, i.e. Active, Cancelled, Ended, etc.
url
string
URL to find details for the specific openhouse.
id
string
Unique ID generated by Retsly to identify the open house.

Example Code

Example URL
https://rets.io/api/v1/test/openhouses?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "agent": "03b546f1dde993a1b6cc8a9e9f1c906a",
      "date": "2015-05-29T22:46:17.517Z",
      "endTime": "2015-05-29T22:46:17.517Z",
      "id": "956ebac2c9081586cd42424eff67bf88",
      "listing": "76188a7a13ecdba318a9b679ad440386",
      "mlsAgentID": "940f403ecf9b8c7627585dc0c5be6432",
      "mlsListingID": "b5e9f0ee637b8e41aada7b5139e7634c",
      "mlsOpenhouseID": "7dd3b1d95256bd0a218e62221e533a4d",
      "remarks": "Dolorem ex repellendus maiores quia nisi eos cum. Doloremque asperiores praesentium officia voluptatem et.\n \r\tPorro ea molestiae perferendis ipsa et eaque consequatur.",
      "startTime": "2015-05-29T22:46:17.517Z",
      "status": "Active",
      "type": "Association",
      "url": "https://rets.io/api/v1/test/openhouses/956ebac2c9081586cd42424eff67bf88"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/openhouses
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/openhouses/{openhouseId}

Description

Retrieves an openhouses.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
openhouseId
string
openhouse id

Response

Name
Type
Description
agent
string
An ID used by Retsly to reference the agent associated with the open house.
mlsOpenhouseID
string
A unique identifier for this record from the immediate source.
listing
string
A generated Retsly listing ID or number that is associated with the open house.
mlsListingID
string
A unique MLS identifier for the listing associated with the open house.
mlsAgentID
string
The MLS ID of the agent who is associated with the open house.
date
string
The date on which the open house will occur.
endTime
string
The end time of the open house.
startTime
string
The start time of the open house.
type
string
The type of open house, i.e. Public, Broker, Office, Private, etc.
remarks
string
Comments, instructions or information about the open house.
status
string
Status of the open house, i.e. Active, Cancelled, Ended, etc.
url
string
URL to find details for the specific openhouse.
id
string
Unique ID generated by Retsly to identify the open house.

Example Code

Example URL
https://rets.io/api/v1/test/openhouses/92b4e7e697e0fb0e2e3732aa701ffa13?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "listing": "2f634f36d7f76fe0e0244c22660552e2",
    "mlsListingID": "8c673001df075ee35d951550625bfee5",
    "agent": "4579df178d374c16f17304cb1d1ac2d5",
    "mlsAgentID": "60a8db4903061be6d3074933570a0649",
    "date": "2016-03-03T00:30:23.061Z",
    "startTime": "2016-03-03T00:30:23.061Z",
    "endTime": "2016-03-03T00:30:23.061Z",
    "type": "Broker",
    "remarks": "Quas tempore esse impedit qui quaerat ullam iste quis. Quas assumenda labore omnis sed nisi. Illo harum unde labore reiciendis.\n \r\tRecusandae et asperiores maiores et doloremque voluptate. Voluptas sequi blanditiis vel incidunt qui et. Corrupti ea ullam.",
    "status": "Active",
    "id": "92b4e7e697e0fb0e2e3732aa701ffa13",
    "mlsOpenhouseID": "b7f4b73bc4a03fc5531883e5c20f618d",
    "url": "https://dev.rets.io/api/v1/test/openhouses/92b4e7e697e0fb0e2e3732aa701ffa13"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/openhouses/{openhouseId}
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/openhouses/{openhouseId}/listing

Description

Retrieves an openhouse's listing.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
openhouseId
string
openhouse id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the listing.
originatingSystemKey
string
The unique identifier from the originating system which is commonly a key to that system.
originatingSystemName
string
The name of the originating record provider. Most commonly the name of the MLS.
mlsListingID
string
The well known identifier for the listing.
unitNumber
string
The unit number pertaining to apartments, etc.
streetName
string
The street name for the listing property.
streetNumber
string
The street number for the listing property.
city
string
The city which the listing property resides in.
state
string
The state which the listing property resides in.
county
string
The county with which the listing property resides in.
country
string
The country with which the listing property resides in.
zipCode
string
The postal code for the listing property.
subdivision
string
The name of the subdivision if the listing property has one.
listDate
string
The date of the agreement between the seller and the seller's broker.
lastModified
string
The date which the posted listing was last modified.
price
number
The current price of the listing property.
previousPrice
number
The last price of the listing property.
originalPrice
number
The first price of the listing property.
closePrice
number
The closing price of the listing property.
buyerFinancing
string
A list of options that describe the type of financing used.
buyerAgencyCompensation
string
The total commission to be paid for this sale, expressed as either a percentage or a constant currency amount.
concessions
string
Are there concessions included in the sales agreement?
concessionsComments
string
Comments describing the concessions made by the buyer or the seller.
concessionsAmount
number
The dollar amount of the concessions
contingency
string
A list of contingencies that must be satisfied in order to complete the transaction.
disclosures
[string]
A list of legal or pertinent information that should be disclosed to potential buyer's agents.
unitsInBuilding
number
The total number of units in the building if applicable.
cancelationDate
string
The cancelation date of the listing if applicable.
expirationDate
string
The expiration date of the listing if applicable.
dateListed
string
The date that the property was first listed.
dateSold
string
The date that the property was sold.
statusChange
string
The date that the contractual status of the listing property was changed.
developmentStatus
[string]
A list of the development status of the property.
ownership
string
A text description of the manner in which title to a property is held.
signOnProperty
boolean
Is there a sign on the property.
financialDataSource
string
A list of the rental information, e.g. Accountant, Owner, etc.
yearBuilt
number
The year which the listing property was built.
yearBuiltDetails
string
A description of the details behind the year the structure was built.
daysOnMarket
number
The number of days the listing property has been posted on the market.
model
string
The model of the mobile or manufactured home.
appliances
[string]
A list of the appliances that will be included in the sale/lease of the property.
telephoneService
[string]
A list of telephone-service related features of the property.
view
[string]
A listed description of the view as seen from the listed property.
waterfront
boolean
A boolean value indicating waterfront property.
waterfrontFeatures
[string]
The features of the waterfront on which the property is located.
waterSource
[string]
A list of the source(s) of water for the property.
zoning
string
Typically a shortcode indicating the zoning given for the lot to discern permissible land uses.
zoningDescription
string
A list of descriptions of the zoning of the property.
acres
number
The number of acres dedicated to the lot of the listed property.
squareFootage
number
The total lot size of the property given in square feet.
livingArea
number
The total livable area within the structure.
entryLevel
number
A numeric field that describes the level within the structure, SFR or a unit in a building, where the main entry to the dwelling is located
aboveGradeFinishedArea
number
The finished area within the structure that is at or above the surface of the ground.
belowGradeFinishedArea
number
The finished area within the structure that is below ground.
stories
number
The number of floors in the property being sold.
storiesTotal
number
The total number of floors in the building.
commonWalls
[string]
A list with options indicating the presence of various types of common walls/wall partitions
baths
number
The simple sum of the number of bathrooms. Two half baths and a full bathroom would be 3 total.
halfBaths
number
The number of rooms containing 2 of 4 elements constituting a bath, e.g. toilet, sink, bathtub, shower.
bedrooms
number
The total number of bedrooms in the dwelling.
roomsTotal
number
The total number of rooms within the listed property.
fireplaces
number
The total number of fireplaces within the listed property.
fireplaceFeatures
[string]
A list of features or description of the fireplace(s) included in the sale/lease.
exteriorFeatures
[string]
A list of features or description of the exterior of the property.
newConstruction
boolean
Is the property newly constructed and has not been previously occupied?
homeWarranty
boolean
Is a home warranty included in the sale of the property?
architecturalStyle
[string]
A list describing the style of the structure.
elementarySchool
string
The name of the primary school having a catchment area that includes the associated property.
middleOrJuniorSchool
string
The name of the junior or middle school having a catchment area that includes the associated property.
highSchool
string
The name of the high school having a catchment area that includes the associated property.
directions
string
Driving directions to the property.
showingInstructions
string
Remarks that detail the seller's instructions for showing the subject property
communityFeatures
[string]
A list of features related to, or available within, the community.
patioAndPorchFeatures
[string]
A list of features or description of the patio or porch included in the sale/lease.
buildingFeatures
[string]
The features or amenities of the building or business park.
interiorFeatures
[string]
A list of features or description of the interior of the property included in the sale/lease.
parkingFeatures
[string]
A list of features or description of the parking included in the sale/lease
lotFeatures
[string]
A list of features or description of the lot included in the sale/lease.
basement
[string]
A list of information and features about the basement.
otherStructures
[string]
A list of structures other than the main dwelling.
lockboxType
[string]
A field describing the type of lock box.
lockboxLocation
string
A field describing the location of the lock box.
exclusions
string
The Elements of the property that will not be included in the sale
petsAllowed
[string]
Are pets allowed at the property being leased?
flooring
[string]
A list of the type(s) of flooring found within the property.
foundationDetails
[string]
A list of the type(s) of foundation on which the property sits.
frontageLength
number
Textual description of the length of the frontages for the listed property.
gas
[string]
A list of gas-service related features of the property.
accessibilityFeatures
[string]
A list or description of the accessibility features included in the sale/lease.
cooling
[string]
A list describing the cooling or air conditioning features of the property.
heating
[string]
A list describing the heating features of the property.
parcelNumber
string
A number used to uniquely identify a parcel or lot. Can vary between county and entered without dashes or hyphens.
additionalParcels
boolean
A boolean indicating if more than one parcel or lot is included in the sale.
occupantType
string
A field that describes the type of occupant, e.g. Owner, Tenant, Vacant.
pool
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
poolFeatures
[string]
A list of features or description of the pool included in the sale/lease.
poolPrivate
boolean
A boolean indicating if the property has a privately owned pool that is included in the sale/lease.
possession
[string]
A list defining when the possession will occur.
roadSurface
[string]
A list of types of surface of the road to access the property.
roof
[string]
A list describing the type or style of roof.
constructionMaterials
[string]
A list of materials that were used in the construction of the property.
sewer
[string]
A list describing the sewer or septic features of the property.
waterSewerExpense
number
The annual water and sewage sexpense that is not paid directly by the tenant and is included in the Operating Expense calculations.
garageSpaces
number
The number of spaces in the garage if applicable.
carportSpaces
number
The number of spaces in the carport if applicable.
openParking
boolean
A boolean indicating if there is open space parking.
attachedGarage
boolean
A flag indicating that the garage is attached to the dwelling.
carport
boolean
A flag indicating that the listing has a garage.
laundry
[string]
List of features and locations where the laundry is located in the property.
type
string
A list of types of properties such as Residential, Lease, Income, Land, Mobile, etc.
subtype
string
A list of types of residential and residential lease properties, e.g. SFR, Condo, etc.
publicRemarks
string
Text remarks that may be displayed to the public.
privateRemarks
string
Remarks that may contain security or proprietary information that should be restricted from public view.
agent
string
An ID used by Retsly to reference the agent associated with the listing.
mlsAgentID
string
A listing specific realtor's MLS ID number.
office
string
An ID used by Retsly to reference the office associated with the listing agent.
mlsOfficeID
string
A listing specific office's MLS ID number.
status
string
Local or regional MLS status.
contractStatusChangeDate
string
The date of the listings contractual status change.
contingentDate
string
The date an offer was made with a contingency.
withdrawnDate
string
Date the listing was withdrawn from the market.
offMarketDate
string
The date the listing was taken off market.
purchaseContractDate
string
With for-sale listings, the date an offer was accepted and the listing was no longer on market.
originalEntryTimestamp
string
The timestamp recorded by the MLS system representing the date/time the listing was entered.
taxAssessedValue
number
The property value as of the last assessment by the taxing authority.
taxAnnual
number
The annual property tax amount as of the last assessment made by the taxing authority.
taxYear
number
The year in which the last assessment of the property value/tax was made.
taxStatus
[string]
A list of the current tax statuses of the mobile home in cases where the land is included in the sale.
association
boolean
Is there a Home Owners Association.
associationName
string
The name of the Home Owners Association.
associationFee
number
A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common area, neighborhood or other association related benefits.
associationFeeFrequency
string
The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc.
associationFeeIncludes
[string]
Services included with the association fee. For example Landscaping, Trash, Water, etc
listingAgentFirstName
string
The first name of the listing agent.
listingAgentLastName
string
The last name of the listing agent.
listingAgentMiddleName
string
The middle name of the listing agent.
listingAgentFullName
string
The full name of the listing agent. (First Middle Last)
listingAgentPhone
string
The preferred phone number of the listing agent.
listingOfficeName
string
The office name associated with the listing agent.
listingOfficePhone
string
The office phone number associated with the listing agent.
coListingAgent
string
A system unique identifier for the co-listing agent
mlsCoListingAgentID
string
The well-known identifier for the co-Listing agent
buyerAgent
string
A system unique identifier for the buyer's agent
mlsBuyerAgentID
string
The well-known identifier for the buyer's agent
coBuyerAgent
string
A system unique identifier for the co-buyer's agent
mlsCoBuyerAgentID
string
The well-known identifier for the co-buyer's agent
listingAgreement
string
The nature of the agreement between the seller and the listing agent
listingTerms
[string]
Terms of the listing such as Lien Release, Subject to Court Approval or Owner Will Carrys
address
string
Complete address for the listing property.
coordinates
[number]
The longitude and latitude associated with the property in the listing.
url
string
URL to find details for the specific listing.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/openhouses/92b4e7e697e0fb0e2e3732aa701ffa13/listing?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "id": "2f634f36d7f76fe0e0244c22660552e2",
    "mlsListingID": "8c673001df075ee35d951550625bfee5",
    "address": "4010 Mount Diablo Boulevard, Lafayette, CA",
    "streetName": "Street St.",
    "streetNumber": "123",
    "city": "Lafayette",
    "state": "CA",
    "county": "Lafayette",
    "country": "USA",
    "zipCode": "94549-3409",
    "subdivision": "Quia incidunt ratione sint explicabo. Provident sit expedita magni. Architecto quisquam quis in aliquid nobis enim.",
    "listDate": "2016-03-03T00:30:27.801Z",
    "lastModified": "2016-03-03T00:30:27.801Z",
    "price": 204842,
    "previousPrice": 108647,
    "originalPrice": 271035,
    "closePrice": 182762,
    "contingency": "Laboriosam consequatur pariatur similique repellat. Dolorem libero blanditiis. Ipsam nam sunt autem.",
    "unitsInBuilding": 157,
    "cancelationDate": null,
    "expirationDate": null,
    "dateListed": "2016-03-03T00:30:27.801Z",
    "dateSold": "2016-03-03T00:30:27.801Z",
    "statusChange": "2016-03-03T00:30:27.801Z",
    "ownership": "Sole P",
    "financialDataSource": "Plumbing Issues,Kitchen Water Leakage,Termites,Foundation Cracks",
    "yearBuilt": 1957,
    "yearBuiltDetails": "Ea quas sunt aut a voluptate distinctio.",
    "daysOnMarket": 191,
    "waterfront": true,
    "zoning": "R-1",
    "zoningDescription": "Agricultural",
    "acres": 5,
    "livingArea": 6419,
    "aboveGradeFinishedArea": 7119,
    "belowGradeFinishedArea": 617,
    "stories": 2,
    "storiesTotal": 6,
    "baths": 3,
    "halfBaths": 2,
    "bedrooms": 2,
    "roomsTotal": 18,
    "fireplaces": 3,
    "frontageLength": 711,
    "additionalParcels": true,
    "occupantType": "Tenant",
    "garageSpaces": 2,
    "pool": true,
    "poolPrivate": false,
    "roof": "Metal,Gravel,Composite,Architectural Style",
    "carportSpaces": 3,
    "status": "Pending",
    "type": "Business",
    "subtype": "Apartment",
    "publicRemarks": "Minima quos quaerat sunt voluptatem labore voluptas.\n \r\tEarum facere et quaerat fugit vel.\n \r\tConsequuntur tempore consequatur perspiciatis eius eveniet est. Beatae quis quasi est sint. Et nisi maxime omnis soluta pariatur at quisquam adipisci.\n \r\tEos sapiente ut amet.",
    "privateRemarks": "Ipsam corporis quas officiis minima pariatur.\n \r\tQuia quia aut explicabo cum atque nemo eum.\n \r\tVoluptatibus omnis non laudantium. Id recusandae eius est molestias quia. Cupiditate saepe velit veritatis quo.\n \r\tDolorem explicabo ea ducimus. Quam qui praesentium dolorem aut. Quia consequatur modi doloribus.",
    "taxAssessedValue": 309028,
    "taxAnnual": 614977,
    "taxYear": 2016,
    "vendorID": "noaccess",
    "taxStatus": null,
    "media": [
      {
        "index": 0,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "cbe745a3697db60cb6720c2663ed68f6"
      },
      {
        "index": 1,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
        "id": "1e397a13fb01a4e1d23916ba7ef6735e"
      },
      {
        "index": 2,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "ed69610588c170c6323b5d7e2dab8f5c"
      },
      {
        "index": 3,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing2.jpg",
        "id": "4594395941055e3567cfcb657bde32e0"
      },
      {
        "index": 4,
        "mimeType": "image/jpeg",
        "url": "http://dev.rets.ly/images/dummy/listing1.jpg",
        "id": "e10b50e384e809209dc423ce1832f42f"
      }
    ],
    "laundry": [
      "In Kitchen"
    ],
    "sewer": [
      "Septic"
    ],
    "constructionMaterials": [
      "Brick"
    ],
    "roadSurface": [
      "Gravel",
      "Rock"
    ],
    "possession": [
      "COE+1"
    ],
    "poolFeatures": [
      "In-ground",
      "Out of ground"
    ],
    "heating": [
      "Forced Air"
    ],
    "cooling": [
      "Evaporative Cooler",
      "Ceiling Fan",
      "Central Air"
    ],
    "accessibilityFeatures": null,
    "gas": [
      "Available"
    ],
    "foundationDetails": [
      "Strip",
      "Pad"
    ],
    "flooring": [
      "Hardwood",
      "Laminate",
      "Vinyl"
    ],
    "exteriorFeatures": [
      "Fenced Yard",
      "Underground Sprinkler"
    ],
    "fireplaceFeatures": [
      "One",
      "Living Room Fireplace",
      "Wood",
      "Gas",
      "Two",
      "Propane"
    ],
    "waterSource": null,
    "view": null,
    "telephoneService": [
      "Available"
    ],
    "appliances": [],
    "termsOfSale": [
      "Survey Required"
    ],
    "disclosures": [
      "No Disclosures"
    ],
    "coordinates": [
      -122.15185,
      37.890361
    ],
    "mlsOfficeID": "1f746cce5698c6769c5f9b97b0787546",
    "office": "0798bb4060682aafd651cd9e2cdf3385",
    "agent": "4579df178d374c16f17304cb1d1ac2d5",
    "mlsAgentID": "60a8db4903061be6d3074933570a0649",
    "url": "https://dev.rets.io/api/v1/test/openhouses/2f634f36d7f76fe0e0244c22660552e2"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/openhouses/{openhouseId}/listing
Getting Response
Response Status
Response Body
Your Response Here

GET

/{dataset}/openhouses/{openhouseId}/agent

Description

Retrieves an openhouse's agent.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
dataset
string
Dataset to get the listings from.
fields
string
Filters Response fields eg. fields=id,price.
openhouseId
string
openhouse id

Response

Name
Type
Description
id
string
Unique ID generated by Retsly to identify the agent.
mlsMemberID
string
A specific realtor's MLS identifier, may be the same as mlsAgentID.
mlsAgentID
string
The MLS's unique system ID number for a specific realtor.
firstName
string
The first name of the listing agent.
lastName
string
The last name of the listing agent.
middleName
string
The middle name of the listing agent.
fullName
string
The full name of the listing agent.
title
string
The title of the listing agent, i.e. Mr., Mrs., Ms., Dr., etc.
cellPhone
string
The cell phone number of the listing agent.
homePhone
string
The home phone number of the listing agent.
stateLicense
string
The state in which the agent is licensed.
address
string
The street number, direction, name and suffix of the agent.
city
string
The city of the agent.
state
string
The state or province in which the agent is addressed.
zipCode
string
The postal code of the agent.
office
string
An ID used by Retsly to reference the office associated with the agent.
mlsOfficeID
string
A specific office's MLS ID number associated with the agent.
officePhone
string
The office phone number associated with the agent.
officeName
string
The office name associated with the agent.
status
string
The status of the agent's MLS account, i.e. active, inactive, under disciplinary action.
type
string
The type of agent, i.e. Agent, Broker, Office Manager, Appraiser, Photographer, Assistants, MLO, Realtor, Association Staff, MLS Staff, etc.
lastModified
string
The date which the agent was last modified.
url
string
URL to find details for the specific agent.
media.id
string
Unique ID generated by Retsly to identify the media.
media.mlsMediaID
string
A specific ID applied to the media by the MLS.
media.url
string
The URL associated to the media.
media.shortDescription
string
A short description about the media.
media.mimeType
string
The type of media being imported.
media.index
number
The numbered index given to the media when imported to the hosting server.

Example Code

Example URL
https://rets.io/api/v1/test/openhouses/92b4e7e697e0fb0e2e3732aa701ffa13/agent?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "id": "4579df178d374c16f17304cb1d1ac2d5",
    "mlsAgentID": "60a8db4903061be6d3074933570a0649",
    "firstName": "Kade",
    "lastName": "Lockman",
    "fullName": "Kade Lockman",
    "cellPhone": "26",
    "homePhone": "22",
    "officePhone": "27",
    "title": "Dr.",
    "office": "74fb2e801c57e016b51c5dede8fb436a",
    "mlsOfficeID": "872003942f46c9510e035df71583d2bb",
    "status": "Inactive",
    "media": [],
    "url": "https://dev.rets.io/api/v1/test/openhouses/4579df178d374c16f17304cb1d1ac2d5"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/{dataset}/openhouses/{openhouseId}/agent
Getting Response
Response Status
Response Body
Your Response Here

/parcels

GET

/pub/parcels

Description

Retrieves a list of parcels.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).
box
string
Coordinates representing a box eg. box=-112.5,33.75,-123,39
poly
string
Minimum 3 pairs of coordinates representing a polygon eg. poly=-112.5,33.75,-123,39,-120,38
geohash
string
Alphanumeric geohash eg. geohash=ezs42

Response

Name
Type
Description
id
number
Unique ID to identify the parcel.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
landUseDescription
string
Description that matches the land use code.
zoningCode
string
Municipality-specific zoning code indicates what part of the zoning or land use bylaw applies to this parcel.
zoningDescription
string
Short description of zoning code.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
lotSizeFrontage
number
Distance in feet between the front of the building and the property boundary
lotSizeDepth
number
Average depth of lot perpendicular to frontage.
lotSizeIrregular
string
Perimeter measurements for non-rectangular shaped lots.
lotTopography
string
Short description of lot topography.
numberOfBuildings
number
Number of buildings included in the parcel.
ownerName
[string]
Full names of the parcel owners.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
building.noOfUnits
number
The total number of units in the building if applicable.
building.occupancyStatus
string
The occupancy status of the building.
building.class
string
The class of the building.
building.quality
string
The quality of the building.
building.condition
string
The condition of the building.
building.architecturalStyle
string
The architectural style of the building.
building.heating
string
Heating feature of the building.
building.airConditioning
string
Air conditioning feature of the building.
building.foundation
string
Foundation feature of the building.
building.fireplace
string
Fireplace feature of the building.
building.water
string
Water source of the building.
building.sewer
string
Sewer or septic features of the building.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.kitchens
number
The total number of kitchens in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.comments
string
Comments about the building.
building.classDescription
string
Description of the building's class.
address.full
string
Full address.
address.city
string
City name.
address.house
string
House number.
address.houseExt
string
House number extension.
address.state
string
State name.
address.street
string
Street name.
address.streetPost
string
Additional street information.
address.streetPre
string
Street prefix.
address.streetSuffix
string
Street suffix.
address.unit
string
Unit number.
address.unitType
string
Unit type.
address.zip
string
Postal code.
address.zip4
string
Zip4.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.

Example Code

Example URL
https://rets.io/api/v1/pub/parcels?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "372176",
      "fips": "01001",
      "apn": "01-04-19-0-000-009.000",
      "county": "AUTAUGA",
      "state": "AL",
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "landUseDescription": "Mobile Home",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": 8,
      "lotSizeSquareFeet": 348480,
      "lotSizeFrontage": null,
      "lotSizeDepth": null,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": 0,
      "address": {
        "full": "100 TEST ST 20 W TESTCITY AL 36051",
        "house": "100",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST ST 20",
        "streetSuffix": null,
        "streetPost": "W ",
        "unitType": null,
        "unit": null,
        "city": "TESTCITY",
        "state": "AL",
        "zip": "36051",
        "zip4": "3009"
      },
      "legal": {
        "lotDescription": "A TRACT OF LAND IN THE SW 1/4 NW 1/4 OF SEC 19T 20N R 16E. BEG AT NW CR OF SAID 40; S TO NR.O.W. OF CO RD; NE'LY ALONG SAID",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": null,
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": null
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": 0,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": "C",
          "condition": "Good",
          "architecturalStyle": null,
          "heating": "Forced air",
          "airConditioning": "Refrigeration",
          "foundation": "Concrete",
          "fireplace": null,
          "water": "Well",
          "sewer": "Septic",
          "yearBuilt": 1998,
          "effectiveYearBuilt": null,
          "totalStories": 1,
          "totalRooms": 7,
          "bedrooms": 0,
          "kitchens": 1,
          "fullBaths": 2,
          "baths": 3,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 2048
        },
        {
          "type": "Perimeter Building Area",
          "areaSquareFeet": 202
        }
      ],
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/372176/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/372176/assessments",
      "comparablesUrl": "https://rets.io/api/v1/pub/parcels/372176/comparables",
      "url": "https://rets.io/api/v1/pub/parcels/372176"
    },
    {
      "id": "378724",
      "fips": "01001",
      "apn": "01-04-19-0-000-009.001",
      "county": "AUTAUGA",
      "state": "AL",
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "landUseDescription": "Mobile Home",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": 6,
      "lotSizeSquareFeet": 261360,
      "lotSizeFrontage": 225,
      "lotSizeDepth": 937,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": 0,
      "address": {
        "full": "100 TEST ST 20 W TESTCITY AL 36051",
        "house": "100",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST ST 20",
        "streetSuffix": null,
        "streetPost": "W ",
        "unitType": null,
        "unit": null,
        "city": "TESTCITY",
        "state": "AL",
        "zip": "36051",
        "zip4": "3009"
      },
      "legal": {
        "lotDescription": "COM NW COR SW 1/4 OF NW 1/4; S 1050' NE 282' TOBEG CONT NE 225' N 836.8' W 225' S'LY 936.8' TOPOB LYING IN SW 1/4 OF NW 1/4",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": null,
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": null
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": 0,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": null,
          "condition": "Good",
          "architecturalStyle": null,
          "heating": "Forced air",
          "airConditioning": "Refrigeration",
          "foundation": "Concrete",
          "fireplace": null,
          "water": "Yes, but not specified",
          "sewer": "Septic",
          "yearBuilt": 1990,
          "effectiveYearBuilt": null,
          "totalStories": 2,
          "totalRooms": 5,
          "bedrooms": 2,
          "kitchens": 1,
          "fullBaths": 0,
          "baths": 2,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 1200
        },
        {
          "type": "Perimeter Building Area",
          "areaSquareFeet": 148
        }
      ],
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/378724/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/378724/assessments",
      "comparablesUrl": "https://rets.io/api/v1/pub/parcels/378724/comparables",
      "url": "https://rets.io/api/v1/pub/parcels/378724"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/parcels
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/parcels/maps

Description

Retrieves map coordinates for parcels. Allows for high limit queries as high as 10,000


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).

Response

Name
Type
Description
coordinates
[number]
The longitude and latitude associated with the property in the listing.
id
string
Unique ID generated by Retsly to identify the listing.
url
string
URL to find details for the specific listing.

Example Code

Example URL
https://rets.io/api/v1/pub/parcels/maps?access_token=6baca547742c6f96a6ff71b138424f21&limit=5
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "coordinates": [
        -86.571562,
        32.575197
      ],
      "id": "9999",
      "url": "https://rets.io/api/v1/pub/parcels/9999",
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/9999/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/9999/assessments"
    },
    {
      "coordinates": [
        -86.569374,
        32.575147
      ],
      "id": "9998",
      "url": "https://rets.io/api/v1/pub/parcels/9998",
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/9998/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/9998/assessments"
    },
    {
      "coordinates": [
        -86.569374,
        32.575147
      ],
      "id": "9997",
      "url": "https://rets.io/api/v1/pub/parcels/9997",
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/9997/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/9997/assessments"
    },
    {
      "coordinates": [
        -86.567186,
        32.575096
      ],
      "id": "9996",
      "url": "https://rets.io/api/v1/pub/parcels/9996",
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/9996/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/9996/assessments"
    },
    {
      "coordinates": [
        -86.565883,
        32.573625
      ],
      "id": "9995",
      "url": "https://rets.io/api/v1/pub/parcels/9995",
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/9995/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/9995/assessments"
    }
  ],
  "total": 5
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/parcels/maps
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/parcels/{parcelId}

Description

Retrieves a single Dataset


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
fields
string
Filters Response fields eg. fields=id,price.
parcelId
string
parcel id

Response

Name
Type
Description
id
number
Unique ID to identify the parcel.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
landUseDescription
string
Description that matches the land use code.
zoningCode
string
Municipality-specific zoning code indicates what part of the zoning or land use bylaw applies to this parcel.
zoningDescription
string
Short description of zoning code.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
lotSizeFrontage
number
Distance in feet between the front of the building and the property boundary
lotSizeDepth
number
Average depth of lot perpendicular to frontage.
lotSizeIrregular
string
Perimeter measurements for non-rectangular shaped lots.
lotTopography
string
Short description of lot topography.
numberOfBuildings
number
Number of buildings included in the parcel.
ownerName
[string]
Full names of the parcel owners.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
building.noOfUnits
number
The total number of units in the building if applicable.
building.occupancyStatus
string
The occupancy status of the building.
building.class
string
The class of the building.
building.quality
string
The quality of the building.
building.condition
string
The condition of the building.
building.architecturalStyle
string
The architectural style of the building.
building.heating
string
Heating feature of the building.
building.airConditioning
string
Air conditioning feature of the building.
building.foundation
string
Foundation feature of the building.
building.fireplace
string
Fireplace feature of the building.
building.water
string
Water source of the building.
building.sewer
string
Sewer or septic features of the building.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.kitchens
number
The total number of kitchens in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.comments
string
Comments about the building.
building.classDescription
string
Description of the building's class.
address.full
string
Full address.
address.city
string
City name.
address.house
string
House number.
address.houseExt
string
House number extension.
address.state
string
State name.
address.street
string
Street name.
address.streetPost
string
Additional street information.
address.streetPre
string
Street prefix.
address.streetSuffix
string
Street suffix.
address.unit
string
Unit number.
address.unitType
string
Unit type.
address.zip
string
Postal code.
address.zip4
string
Zip4.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.

Example Code

Example URL
https://rets.io/api/v1/pub/parcels/1951208?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "id": "372176",
    "fips": "01001",
    "apn": "01-04-19-0-000-009.000",
    "county": "AUTAUGA",
    "state": "AL",
    "landUseGeneral": "RR",
    "landUseCode": "RR103",
    "landUseDescription": "Mobile Home",
    "zoningCode": null,
    "zoningDescription": null,
    "lotSizeAcres": 8,
    "lotSizeSquareFeet": 348480,
    "lotSizeFrontage": null,
    "lotSizeDepth": null,
    "lotSizeIrregular": null,
    "lotTopography": null,
    "numberOfBuildings": 0,
    "address": {
      "full": "100 TEST ST 20 W TESTCITY AL 36051",
      "house": "100",
      "houseExt": null,
      "streetPre": null,
      "street": "TEST ST 20",
      "streetSuffix": null,
      "streetPost": "W ",
      "unitType": null,
      "unit": null,
      "city": "TESTCITY",
      "state": "AL",
      "zip": "36051",
      "zip4": "3009"
    },
    "legal": {
      "lotDescription": "A TRACT OF LAND IN THE SW 1/4 NW 1/4 OF SEC 19T 20N R 16E. BEG AT NW CR OF SAID 40; S TO NR.O.W. OF CO RD; NE'LY ALONG SAID",
      "lot": null,
      "otherLot": null,
      "block": null,
      "subdivisionName": null,
      "unit": null,
      "section": null,
      "phase": null,
      "tract": null,
      "district": null,
      "municipality": null,
      "city": null,
      "township": null
    },
    "coordinates": [
      -122.000001,
      47.600001
    ],
    "building": [
      {
        "noOfUnits": 0,
        "occupancyStatus": "Owner Occupied or Primary Residence",
        "class": null,
        "classDescription": null,
        "quality": "C",
        "condition": "Good",
        "architecturalStyle": null,
        "heating": "Forced air",
        "airConditioning": "Refrigeration",
        "foundation": "Concrete",
        "fireplace": null,
        "water": "Well",
        "sewer": "Septic",
        "yearBuilt": 1998,
        "effectiveYearBuilt": null,
        "totalStories": 1,
        "totalRooms": 7,
        "bedrooms": 0,
        "kitchens": 1,
        "fullBaths": 2,
        "baths": 3,
        "comments": null
      }
    ],
    "areas": [
      {
        "type": "Living Building Area",
        "areaSquareFeet": 2048
      },
      {
        "type": "Perimeter Building Area",
        "areaSquareFeet": 202
      }
    ],
    "ownerName": [
      "JANE DOE",
      "JOE SMITH"
    ],
    "transactionsUrl": "https://rets.io/api/v1/pub/parcels/372176/transactions",
    "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/372176/assessments",
    "comparablesUrl": "https://rets.io/api/v1/pub/parcels/372176/comparables",
    "url": "https://rets.io/api/v1/pub/parcels/372176"
  }
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/parcels/{parcelId}
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/parcels/{parcelId}/assessments

Description

Retrieves a list of assessments for a given parcel.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
fields
string
Filters Response fields eg. fields=id,price.
parcelId
string
parcel id

Response

Name
Type
Description
id
number
Unique ID to identify the assessment.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
censusTract
string
Geographic region used by the US Census Bureau.
taxID
string
Unique identifier assigned for taxation purposes (different from APN).
taxAmount
number
Total dollar amount of property tax.
taxYear
number
Calendar year corresponding to the tax amount. May be different from year b/c some counties do not reassess every year.
taxExemption
string
Type of tax exemption, if any.
year
number
Assessment year.
landValue
number
Assessed value of land.
improvementValue
number
Assessed value of improvements
totalValue
number
Total assessed value of land and improvements.
marketValueYear
number
Year that the market assessment was made.
marketLandValue
number
Market assessed value of land.
marketImprovementValue
number
Market assessed value of improvements
marketTotalValue
number
Total market assessed value of land and improvements.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
landUseDescription
string
Description that matches the land use code.
zoningCode
string
Municipality-specific zoning code indicates what part of the zoning or land use bylaw applies to this parcel.
zoningDescription
string
Short description of zoning code.
numberOfBuildings
number
Number of buildings.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
lotSizeFrontage
number
Width of the lot at the street (or shore for properties with water access).
lotSizeDepth
number
Average depth of lot perpendicular to frontage.
lotSizeIrregular
string
Perimeter measurements for non-rectangular shaped lots.
lotTopography
string
Short description of lot topography.
ownerName
string
Name of owner.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
building.noOfUnits
number
The total number of units in the building if applicable.
building.occupancyStatus
string
The occupancy status of the building.
building.class
string
The class of the building.
building.quality
string
The quality of the building.
building.condition
string
The condition of the building.
building.architecturalStyle
string
The architectural style of the building.
building.heating
string
Heating feature of the building.
building.airConditioning
string
Air conditioning feature of the building.
building.foundation
string
Foundation feature of the building.
building.fireplace
string
Fireplace feature of the building.
building.water
string
Water source of the building.
building.sewer
string
Sewer or septic features of the building.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.kitchens
number
The total number of kitchens in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.comments
string
Comments about the building.
building.classDescription
string
Description of the building's class.
address.full
string
Full address.
address.city
string
City name.
address.house
string
House number.
address.houseExt
string
House number extension.
address.state
string
State name.
address.street
string
Street name.
address.streetPost
string
Additional street information.
address.streetPre
string
Street prefix.
address.streetSuffix
string
Street suffix.
address.unit
string
Unit number.
address.unitType
string
Unit type.
address.zip
string
Postal code.
address.zip4
string
Zip4.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.

Example Code

Example URL
https://rets.io/api/v1/pub/parcels/1951208/assessments?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "372176",
      "fips": "01001",
      "apn": "01-04-19-0-000-009.000",
      "county": "AUTAUGA",
      "state": "AL",
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "landUseDescription": "Mobile Home",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": 8,
      "lotSizeSquareFeet": 348480,
      "lotSizeFrontage": null,
      "lotSizeDepth": null,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": 0,
      "address": {
        "full": "100 TEST ST 20 W TESTCITY AL 36051",
        "house": "100",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST ST 20",
        "streetSuffix": null,
        "streetPost": "W ",
        "unitType": null,
        "unit": null,
        "city": "TESTCITY",
        "state": "AL",
        "zip": "36051",
        "zip4": "3009"
      },
      "legal": {
        "lotDescription": "A TRACT OF LAND IN THE SW 1/4 NW 1/4 OF SEC 19T 20N R 16E. BEG AT NW CR OF SAID 40; S TO NR.O.W. OF CO RD; NE'LY ALONG SAID",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": null,
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": null
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": 0,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": "C",
          "condition": "Good",
          "architecturalStyle": null,
          "heating": "Forced air",
          "airConditioning": "Refrigeration",
          "foundation": "Concrete",
          "fireplace": null,
          "water": "Well",
          "sewer": "Septic",
          "yearBuilt": 1998,
          "effectiveYearBuilt": null,
          "totalStories": 1,
          "totalRooms": 7,
          "bedrooms": 0,
          "kitchens": 1,
          "fullBaths": 2,
          "baths": 3,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 2048
        },
        {
          "type": "Perimeter Building Area",
          "areaSquareFeet": 202
        }
      ],
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/372176/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/372176/assessments",
      "comparablesUrl": "https://rets.io/api/v1/pub/parcels/372176/comparables",
      "url": "https://rets.io/api/v1/pub/parcels/372176"
    },
    {
      "id": "378724",
      "fips": "01001",
      "apn": "01-04-19-0-000-009.001",
      "county": "AUTAUGA",
      "state": "AL",
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "landUseDescription": "Mobile Home",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": 6,
      "lotSizeSquareFeet": 261360,
      "lotSizeFrontage": 225,
      "lotSizeDepth": 937,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": 0,
      "address": {
        "full": "100 TEST ST 20 W TESTCITY AL 36051",
        "house": "100",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST ST 20",
        "streetSuffix": null,
        "streetPost": "W ",
        "unitType": null,
        "unit": null,
        "city": "TESTCITY",
        "state": "AL",
        "zip": "36051",
        "zip4": "3009"
      },
      "legal": {
        "lotDescription": "COM NW COR SW 1/4 OF NW 1/4; S 1050' NE 282' TOBEG CONT NE 225' N 836.8' W 225' S'LY 936.8' TOPOB LYING IN SW 1/4 OF NW 1/4",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": null,
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": null
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": 0,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": null,
          "condition": "Good",
          "architecturalStyle": null,
          "heating": "Forced air",
          "airConditioning": "Refrigeration",
          "foundation": "Concrete",
          "fireplace": null,
          "water": "Yes, but not specified",
          "sewer": "Septic",
          "yearBuilt": 1990,
          "effectiveYearBuilt": null,
          "totalStories": 2,
          "totalRooms": 5,
          "bedrooms": 2,
          "kitchens": 1,
          "fullBaths": 0,
          "baths": 2,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 1200
        },
        {
          "type": "Perimeter Building Area",
          "areaSquareFeet": 148
        }
      ],
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/378724/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/378724/assessments",
      "comparablesUrl": "https://rets.io/api/v1/pub/parcels/378724/comparables",
      "url": "https://rets.io/api/v1/pub/parcels/378724"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/parcels/{parcelId}/assessments
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/parcels/{parcelId}/transactions

Description

Retrieves a list of transactions for a given parcel.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
fields
string
Filters Response fields eg. fields=id,price.
parcelId
string
parcel id

Response

Name
Type
Description
id
number
Unique ID to identify the transaction.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
recordType
string
Two character code for record type.
recordingDate
string
The date this transaction was recorded.
recordingBookNumber
string
System book number of record.
recordingPageNumber
string
System page number of record.
documentTypeCode
string
Four character code for document type.
documentType
string
Short description of document type.
documentDate
string
Document creation date.
signatureDate
string
Date transaction was signed.
effectiveDate
string
Effective date transaction takes effect.
buyerVesting
number
Vesting process for buyer.
buyerMultiVesting
string
Flag for multi vesting.
partialInterestTransfer
string
Flag for partial interest transfers.
partialInterestTransferPercent
number
Percent of partial interest transfer.
salesPrice
number
Price of the sale.
cityTransferTax
number
City transfer tax.
countyTransferTax
number
County transfer tax.
stateTransferTax
number
County transfer tax.
totalTransferTax
number
Total transfer tax.
intraFamilyTransfer
string
Flag for intra family transfers.
transferTaxExempt
string
Flag for transfer tax exemption.
buyerName
[string]
Buyer names.
sellerName
[string]
Seller names.
borrowerVesting
string
Description of vesting process.
lenderName
string
Name of lender.
lenderType
string
The type of institution (bank, private lender, etc).
loanAmount
number
Amount of loan.
loanAmountDescription
string
Description of loan amount.
maxLoanAmount
number
Maximum amount of loan.
loanTypeCode
string
Loan type code.
loanClosedOrOpenEndedCode
string
Code for whether the loan is close or open ended.
loanRateTypeCode
number
Code for the loan rate type.
loanDueDate
string
Due date of the loan.
loanTermMonths
number
Length of loan term in months (only one of loanTermMonths or loanTermYears is shown).
loanTermYears
number
Length of loan term in years.
initialInterestRate
number
Initial interest rate of the loan.
unpaidBalance
number
Amount of the balance unpaid.
totalDelinquentAmount
number
Final amount to be settled on the foreclosure.
delinquentAsOfDate
string
Start date of the delinquency.
installmentAmount
number
Amount of the foreclosure installments.
installmentDueDate
string
Due date of foreclosure installments.
origLoanAmount
number
Amount of the original loan.
origLoanDocumentDate
string
Date of the original loan document.
origLoanRecordingDate
string
Recording date of the original loan.
origLoanDocumentNumber
string
Document number of the original loan.
occupancyStatus
string
Occupancy status.
trusteeSaleNumber
string
Trustee sale number.
auctionAddress
string
Auction city and street address.
auctionDate
string
Date of the auction.
startingBid
number
Auction starting bid amount.
parcels.full
string
Full address
parcels.apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
parcels.fips
string
Five digit county code ID.
parcels.city
string
City name.
parcels.house
string
House number.
parcels.houseExt
string
House number extension.
parcels.state
string
State name.
parcels.street
string
Street name.
parcels.streetPost
string
Additional street information.
parcels.streetPre
string
Street prefix.
parcels.streetSuffix
string
Street suffix.
parcels.unit
string
Unit number.
parcels.unitType
string
Unit type.
parcels.zip
string
Postal code.
parcels.zip4
string
Zip4.
parcels.coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].

Example Code

Example URL
https://rets.io/api/v1/pub/parcels/1951208/transactions?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "372176",
      "fips": "01001",
      "apn": "01-04-19-0-000-009.000",
      "county": "AUTAUGA",
      "state": "AL",
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "landUseDescription": "Mobile Home",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": 8,
      "lotSizeSquareFeet": 348480,
      "lotSizeFrontage": null,
      "lotSizeDepth": null,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": 0,
      "address": {
        "full": "100 TEST ST 20 W TESTCITY AL 36051",
        "house": "100",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST ST 20",
        "streetSuffix": null,
        "streetPost": "W ",
        "unitType": null,
        "unit": null,
        "city": "TESTCITY",
        "state": "AL",
        "zip": "36051",
        "zip4": "3009"
      },
      "legal": {
        "lotDescription": "A TRACT OF LAND IN THE SW 1/4 NW 1/4 OF SEC 19T 20N R 16E. BEG AT NW CR OF SAID 40; S TO NR.O.W. OF CO RD; NE'LY ALONG SAID",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": null,
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": null
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": 0,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": "C",
          "condition": "Good",
          "architecturalStyle": null,
          "heating": "Forced air",
          "airConditioning": "Refrigeration",
          "foundation": "Concrete",
          "fireplace": null,
          "water": "Well",
          "sewer": "Septic",
          "yearBuilt": 1998,
          "effectiveYearBuilt": null,
          "totalStories": 1,
          "totalRooms": 7,
          "bedrooms": 0,
          "kitchens": 1,
          "fullBaths": 2,
          "baths": 3,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 2048
        },
        {
          "type": "Perimeter Building Area",
          "areaSquareFeet": 202
        }
      ],
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/372176/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/372176/assessments",
      "comparablesUrl": "https://rets.io/api/v1/pub/parcels/372176/comparables",
      "url": "https://rets.io/api/v1/pub/parcels/372176"
    },
    {
      "id": "378724",
      "fips": "01001",
      "apn": "01-04-19-0-000-009.001",
      "county": "AUTAUGA",
      "state": "AL",
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "landUseDescription": "Mobile Home",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": 6,
      "lotSizeSquareFeet": 261360,
      "lotSizeFrontage": 225,
      "lotSizeDepth": 937,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": 0,
      "address": {
        "full": "100 TEST ST 20 W TESTCITY AL 36051",
        "house": "100",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST ST 20",
        "streetSuffix": null,
        "streetPost": "W ",
        "unitType": null,
        "unit": null,
        "city": "TESTCITY",
        "state": "AL",
        "zip": "36051",
        "zip4": "3009"
      },
      "legal": {
        "lotDescription": "COM NW COR SW 1/4 OF NW 1/4; S 1050' NE 282' TOBEG CONT NE 225' N 836.8' W 225' S'LY 936.8' TOPOB LYING IN SW 1/4 OF NW 1/4",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": null,
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": null
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": 0,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": null,
          "condition": "Good",
          "architecturalStyle": null,
          "heating": "Forced air",
          "airConditioning": "Refrigeration",
          "foundation": "Concrete",
          "fireplace": null,
          "water": "Yes, but not specified",
          "sewer": "Septic",
          "yearBuilt": 1990,
          "effectiveYearBuilt": null,
          "totalStories": 2,
          "totalRooms": 5,
          "bedrooms": 2,
          "kitchens": 1,
          "fullBaths": 0,
          "baths": 2,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 1200
        },
        {
          "type": "Perimeter Building Area",
          "areaSquareFeet": 148
        }
      ],
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/378724/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/378724/assessments",
      "comparablesUrl": "https://rets.io/api/v1/pub/parcels/378724/comparables",
      "url": "https://rets.io/api/v1/pub/parcels/378724"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/parcels/{parcelId}/transactions
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/parcels/{parcelId}/comps

Description

Retrieves a list of comparable parcels.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
parcelId
string
parcel id

Response

Name
Type
Description
id
number
Unique ID to identify the parcel.
fips
string
Five digit county code ID.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
city
string
City name.
county
string
County name.
state
string
Two character state abbreviation.
zip
string
Zip code.
zip4
string
Zip4 code.
salesPrice
number
Price of the sale.
recordingBookNumber
string
System book number of record.
recordingPageNumber
string
System page number of record.
documentType
string
Short description of document type.
documentDate
string
Document creation date.
buyerName
[string]
Buyer names.
sellerName
[string]
Seller names.
lenderName
string
Name of lender.
lenderType
string
The type of institution (bank, private lender, etc).
loanAmount
number
Amount of loan.
loanAmountDescription
string
Description of loan amount.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
distanceFrom
number
Distance in miles from the parcel.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
address.full
string
Full address.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.areaSquareFeet
number
Area in square feet.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.

Example Code

Example URL
https://rets.io/api/v1/pub/parcels/1951208/comps?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "1951257",
      "fips": "01001",
      "apn": "50-20-05-22-0-000-017.002",
      "city": "TESTVILLE",
      "county": "TESTCOUNTY",
      "state": "AL",
      "zip": "00001",
      "zip4": "3140",
      "salesPrice": 9500,
      "documentDate": "2012-05-31T00:00:00.000Z",
      "loanAmount": 0,
      "loanAmountDescription": null,
      "lenderName": null,
      "lenderType": null,
      "recordingBookNumber": "5352",
      "recordingPageNumber": "344",
      "documentType": "Warranty Deed",
      "lotSizeAcres": 0.5,
      "lotSizeSquareFeet": 21780,
      "landUseGeneral": "RR",
      "landUseCode": "RR103",
      "buyerName": [
        "JOE DOE",
        "JANE SMITH"
      ],
      "sellerName": [
        "JOE SMITH",
        "JANE DOE"
      ],
      "address": {
        "full": "63 TEST RD TESTVILLE AL 00000"
      },
      "legal": {
        "lot": null,
        "lotDescription": "COMM AT THE SW COR OF SEC 22-9-3 THN E 393.3'; THN N 345.7'; TO THE POB; THN CONT N 342' TO THE SOUTH MARGIN OF ROCK SPRINGS",
        "subdivisionName": null
      },
      "coordinates": [
        -87.000001,
        41.000001
      ],
      "building": [
        {
          "totalStories": 2,
          "totalRooms": 2,
          "bedrooms": 1,
          "fullBaths": 1,
          "baths": 1,
          "yearBuilt": 1983,
          "effectiveYearBuilt": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 1200
        }
      ],
      "distanceFrom": 2.4748345485743757,
      "transactionsUrl": "https://rets.io/api/v1/pub/parcels/1951257/transactions",
      "assessmentsUrl": "https://rets.io/api/v1/pub/parcels/1951257/assessments",
      "url": "https://rets.io/api/v1/pub/parcels/1951257"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/parcels/{parcelId}/comps
Getting Response
Response Status
Response Body
Your Response Here

/assessments

GET

/pub/assessments

Description

Retrieves a list of assessments.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).
box
string
Coordinates representing a box eg. box=-112.5,33.75,-123,39
poly
string
Minimum 3 pairs of coordinates representing a polygon eg. poly=-112.5,33.75,-123,39,-120,38
geohash
string
Alphanumeric geohash eg. geohash=ezs42

Response

Name
Type
Description
id
number
Unique ID to identify the assessment.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
censusTract
string
Geographic region used by the US Census Bureau.
taxID
string
Unique identifier assigned for taxation purposes (different from APN).
taxAmount
number
Total dollar amount of property tax.
taxYear
number
Calendar year corresponding to the tax amount. May be different from year b/c some counties do not reassess every year.
taxExemption
string
Type of tax exemption, if any.
year
number
Assessment year.
landValue
number
Assessed value of land.
improvementValue
number
Assessed value of improvements
totalValue
number
Total assessed value of land and improvements.
marketValueYear
number
Year that the market assessment was made.
marketLandValue
number
Market assessed value of land.
marketImprovementValue
number
Market assessed value of improvements
marketTotalValue
number
Total market assessed value of land and improvements.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
landUseDescription
string
Description that matches the land use code.
zoningCode
string
Municipality-specific zoning code indicates what part of the zoning or land use bylaw applies to this parcel.
zoningDescription
string
Short description of zoning code.
numberOfBuildings
number
Number of buildings.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
lotSizeFrontage
number
Width of the lot at the street (or shore for properties with water access).
lotSizeDepth
number
Average depth of lot perpendicular to frontage.
lotSizeIrregular
string
Perimeter measurements for non-rectangular shaped lots.
lotTopography
string
Short description of lot topography.
ownerName
string
Name of owner.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
building.noOfUnits
number
The total number of units in the building if applicable.
building.occupancyStatus
string
The occupancy status of the building.
building.class
string
The class of the building.
building.quality
string
The quality of the building.
building.condition
string
The condition of the building.
building.architecturalStyle
string
The architectural style of the building.
building.heating
string
Heating feature of the building.
building.airConditioning
string
Air conditioning feature of the building.
building.foundation
string
Foundation feature of the building.
building.fireplace
string
Fireplace feature of the building.
building.water
string
Water source of the building.
building.sewer
string
Sewer or septic features of the building.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.kitchens
number
The total number of kitchens in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.comments
string
Comments about the building.
building.classDescription
string
Description of the building's class.
address.full
string
Full address.
address.city
string
City name.
address.house
string
House number.
address.houseExt
string
House number extension.
address.state
string
State name.
address.street
string
Street name.
address.streetPost
string
Additional street information.
address.streetPre
string
Street prefix.
address.streetSuffix
string
Street suffix.
address.unit
string
Unit number.
address.unitType
string
Unit type.
address.zip
string
Postal code.
address.zip4
string
Zip4.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.

Example Code

Example URL
https://rets.io/api/v1/pub/assessments?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "778288042",
      "parcelID": "393852",
      "apn": "19-03-06-4-000-001.048",
      "fips": "01001",
      "county": "AUTAUGA",
      "state": "AL",
      "censusTract": null,
      "taxID": null,
      "taxAmount": 179.64,
      "taxYear": 2006,
      "taxExemption": null,
      "year": 2006,
      "landValue": 1800,
      "improvementValue": 6080,
      "totalValue": 7880,
      "marketValueYear": 2006,
      "marketLandValue": 18000,
      "marketImprovementValue": 60850,
      "marketTotalValue": 78850,
      "landUseGeneral": "RR",
      "landUseCode": "RR101",
      "landUseDescription": "Single Family Residential",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": null,
      "lotSizeSquareFeet": null,
      "lotSizeFrontage": null,
      "lotSizeDepth": null,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": null,
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "address": {
        "full": "422 TEST ST PRATTVILLE AL 36067",
        "house": "422",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST",
        "streetSuffix": "ST",
        "streetPost": null,
        "unitType": null,
        "unit": null,
        "city": "PRATTVILLE",
        "state": "AL",
        "zip": "36067",
        "zip4": "1543"
      },
      "legal": {
        "lotDescription": "LOT 17 BLK A WESTERN RIDGE #1-B",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": "WESTERN RIDGE PLAT 1-B MB3P108",
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": "PRATTVILLE"
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": null,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": "C",
          "condition": null,
          "architecturalStyle": null,
          "heating": "Central",
          "airConditioning": "Central",
          "foundation": "Slab",
          "fireplace": null,
          "water": "Yes, but not specified",
          "sewer": "Septic",
          "yearBuilt": 1987,
          "effectiveYearBuilt": null,
          "totalStories": 1,
          "totalRooms": 3,
          "bedrooms": 1,
          "kitchens": 1,
          "fullBaths": 1,
          "baths": 2,
          "comments": null
        }
      ],
      "areas": [],
      "url": "https://rets.io/api/v1/pub/assessments/778288042"
    },
    {
      "id": "778225017",
      "parcelID": "389705",
      "apn": "19-03-06-4-000-001.049",
      "fips": "01001",
      "county": "AUTAUGA",
      "state": "AL",
      "censusTract": null,
      "taxID": "22848480",
      "taxAmount": 237.38,
      "taxYear": 2008,
      "taxExemption": null,
      "year": 2008,
      "landValue": 2040,
      "improvementValue": 6940,
      "totalValue": 8980,
      "marketValueYear": 2008,
      "marketLandValue": 20340,
      "marketImprovementValue": 69480,
      "marketTotalValue": 89820,
      "landUseGeneral": "RR",
      "landUseCode": "RR101",
      "landUseDescription": "Single Family Residential",
      "zoningCode": null,
      "zoningDescription": null,
      "lotSizeAcres": null,
      "lotSizeSquareFeet": null,
      "lotSizeFrontage": null,
      "lotSizeDepth": null,
      "lotSizeIrregular": null,
      "lotTopography": null,
      "numberOfBuildings": null,
      "ownerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "address": {
        "full": "435 TEST ST PRATTVILLE AL 36067",
        "house": "435",
        "houseExt": null,
        "streetPre": null,
        "street": "TEST",
        "streetSuffix": "ST",
        "streetPost": null,
        "unitType": null,
        "unit": null,
        "city": "PRATTVILLE",
        "state": "AL",
        "zip": "36067",
        "zip4": "1539"
      },
      "legal": {
        "lotDescription": "LOT 18 BLK AWESTERN RIDGE PLAT 1 B",
        "lot": null,
        "otherLot": null,
        "block": null,
        "subdivisionName": "WESTERN RIDGE PLAT 1-B MB3P108",
        "unit": null,
        "section": null,
        "phase": null,
        "tract": null,
        "district": null,
        "municipality": null,
        "city": null,
        "township": "PRATTVILLE"
      },
      "coordinates": [
        -122.000001,
        47.600001
      ],
      "building": [
        {
          "noOfUnits": null,
          "occupancyStatus": "Owner Occupied or Primary Residence",
          "class": null,
          "classDescription": null,
          "quality": "C",
          "condition": null,
          "architecturalStyle": null,
          "heating": "Central",
          "airConditioning": "Central",
          "foundation": "Slab",
          "fireplace": null,
          "water": "Well",
          "sewer": "Septic",
          "yearBuilt": 1986,
          "effectiveYearBuilt": null,
          "totalStories": 1,
          "totalRooms": 7,
          "bedrooms": 3,
          "kitchens": 1,
          "fullBaths": 1,
          "baths": 2,
          "comments": null
        }
      ],
      "areas": [
        {
          "type": "Living Building Area",
          "areaSquareFeet": 1205
        }
      ],
      "url": "https://rets.io/api/v1/pub/assessments/778225017"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/assessments
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/assessments/maps

Description

Retrieves map coordinates for assesments. Allows for high limit queries as high as 10,000


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).

Response

Name
Type
Description
coordinates
[number]
The longitude and latitude associated with the property in the listing.
id
string
Unique ID generated by Retsly to identify the listing.
url
string
URL to find details for the specific listing.

Example Code

Example URL
https://rets.io/api/v1/pub/assessments/maps?access_token=6baca547742c6f96a6ff71b138424f21&limit=5
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "coordinates": [
        -86.571562,
        32.575197
      ],
      "id": "9999",
      "url": "https://rets.io/api/v1/pub/assessments/9999"
    },
    {
      "coordinates": [
        -86.569374,
        32.575147
      ],
      "id": "9998",
      "url": "https://rets.io/api/v1/pub/assessments/9998"
    },
    {
      "coordinates": [
        -86.569374,
        32.575147
      ],
      "id": "9997",
      "url": "https://rets.io/api/v1/pub/assessments/9997"
    },
    {
      "coordinates": [
        -86.567186,
        32.575096
      ],
      "id": "9996",
      "url": "https://rets.io/api/v1/pub/assessments/9996"
    },
    {
      "coordinates": [
        -86.565883,
        32.573625
      ],
      "id": "9995",
      "url": "https://rets.io/api/v1/pub/assessments/9995"
    }
  ],
  "total": 5
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/assessments/maps
Getting Response
Response Status
Response Body
Your Response Here

/transactions

GET

/pub/transactions

Description

Retrieves a list of transactions.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).
box
string
Coordinates representing a box eg. box=-112.5,33.75,-123,39
poly
string
Minimum 3 pairs of coordinates representing a polygon eg. poly=-112.5,33.75,-123,39,-120,38
geohash
string
Alphanumeric geohash eg. geohash=ezs42

Response

Name
Type
Description
id
number
Unique ID to identify the transaction.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
recordType
string
Two character code for record type.
recordingDate
string
The date this transaction was recorded.
recordingBookNumber
string
System book number of record.
recordingPageNumber
string
System page number of record.
documentTypeCode
string
Four character code for document type.
documentType
string
Short description of document type.
documentDate
string
Document creation date.
signatureDate
string
Date transaction was signed.
effectiveDate
string
Effective date transaction takes effect.
buyerVesting
number
Vesting process for buyer.
buyerMultiVesting
string
Flag for multi vesting.
partialInterestTransfer
string
Flag for partial interest transfers.
partialInterestTransferPercent
number
Percent of partial interest transfer.
salesPrice
number
Price of the sale.
cityTransferTax
number
City transfer tax.
countyTransferTax
number
County transfer tax.
stateTransferTax
number
County transfer tax.
totalTransferTax
number
Total transfer tax.
intraFamilyTransfer
string
Flag for intra family transfers.
transferTaxExempt
string
Flag for transfer tax exemption.
buyerName
[string]
Buyer names.
sellerName
[string]
Seller names.
borrowerVesting
string
Description of vesting process.
lenderName
string
Name of lender.
lenderType
string
The type of institution (bank, private lender, etc).
loanAmount
number
Amount of loan.
loanAmountDescription
string
Description of loan amount.
maxLoanAmount
number
Maximum amount of loan.
loanTypeCode
string
Loan type code.
loanClosedOrOpenEndedCode
string
Code for whether the loan is close or open ended.
loanRateTypeCode
number
Code for the loan rate type.
loanDueDate
string
Due date of the loan.
loanTermMonths
number
Length of loan term in months (only one of loanTermMonths or loanTermYears is shown).
loanTermYears
number
Length of loan term in years.
initialInterestRate
number
Initial interest rate of the loan.
unpaidBalance
number
Amount of the balance unpaid.
totalDelinquentAmount
number
Final amount to be settled on the foreclosure.
delinquentAsOfDate
string
Start date of the delinquency.
installmentAmount
number
Amount of the foreclosure installments.
installmentDueDate
string
Due date of foreclosure installments.
origLoanAmount
number
Amount of the original loan.
origLoanDocumentDate
string
Date of the original loan document.
origLoanRecordingDate
string
Recording date of the original loan.
origLoanDocumentNumber
string
Document number of the original loan.
occupancyStatus
string
Occupancy status.
trusteeSaleNumber
string
Trustee sale number.
auctionAddress
string
Auction city and street address.
auctionDate
string
Date of the auction.
startingBid
number
Auction starting bid amount.
parcels.full
string
Full address
parcels.apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
parcels.fips
string
Five digit county code ID.
parcels.city
string
City name.
parcels.house
string
House number.
parcels.houseExt
string
House number extension.
parcels.state
string
State name.
parcels.street
string
Street name.
parcels.streetPost
string
Additional street information.
parcels.streetPre
string
Street prefix.
parcels.streetSuffix
string
Street suffix.
parcels.unit
string
Unit number.
parcels.unitType
string
Unit type.
parcels.zip
string
Postal code.
parcels.zip4
string
Zip4.
parcels.coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].

Example Code

Example URL
https://rets.io/api/v1/pub/transactions?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "545835898",
      "parcelID": "129291435",
      "fips": "45073",
      "county": "OCONEE",
      "state": "SC",
      "category": "deed",
      "recordType": "Primary Record",
      "recordingDate": "2011-10-19T00:00:00.000Z",
      "recordingBookNumber": "1861",
      "recordingPageNumber": "212",
      "documentTypeCode": 54,
      "documentType": "Deed",
      "documentDate": "2011-10-07T00:00:00.000Z",
      "signatureDate": null,
      "effectiveDate": null,
      "buyerVesting": 7,
      "buyerMultiVesting": " ",
      "partialInterestTransfer": null,
      "partialInterestTransferPercent": null,
      "salesPrice": 25000,
      "cityTransferTax": 6500,
      "countyTransferTax": 2750,
      "stateTransferTax": null,
      "totalTransferTax": 9250,
      "intraFamilyTransfer": null,
      "transferTaxExempt": null,
      "borrowerVesting": null,
      "lenderName": null,
      "titleCompanyName": null,
      "lenderType": null,
      "loanAmount": 0,
      "loanAmountDescription": null,
      "maxLoanAmount": null,
      "loanTypeCode": null,
      "loanClosedOrOpenEndedCode": null,
      "loanRateTypeCode": null,
      "loanDueDate": null,
      "loanTermMonths": null,
      "loanTermYears": null,
      "initialInterestRate": null,
      "unpaidBalance": null,
      "totalDelinquentAmount": null,
      "delinquentAsOfDate": null,
      "installmentAmount": null,
      "installmentDueDate": null,
      "origLoanAmount": null,
      "origLoanDocumentDate": null,
      "origLoanRecordingDate": null,
      "origLoanDocumentNumber": null,
      "occupancyStatus": null,
      "trusteeSaleNumber": null,
      "auctionAddress": "",
      "auctionDate": null,
      "startingBid": null,
      "buyerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "sellerName": [
        "TOM JONES"
      ],
      "parcels": [
        {
          "apn": "261-00-02-011",
          "fips": "45073",
          "full": "999 N TEST RD WESTMINSTER SC 29693",
          "house": null,
          "houseExt": null,
          "streetPre": null,
          "street": null,
          "streetSuffix": null,
          "streetPost": null,
          "unitType": null,
          "unit": null,
          "city": "WESTMINSTER",
          "state": "SC",
          "zip": "29693",
          "zip4": "4012",
          "coordinates": [
            -122.000001,
            47.600001
          ]
        },
        {
          "apn": "261-00-02-016",
          "fips": "45073",
          "full": "",
          "house": null,
          "houseExt": null,
          "streetPre": null,
          "street": null,
          "streetSuffix": null,
          "streetPost": null,
          "unitType": null,
          "unit": null,
          "city": null,
          "state": null,
          "zip": null,
          "zip4": null,
          "coordinates": [
            0,
            0
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/545835898"
    },
    {
      "id": "281444018",
      "parcelID": "26258278",
      "fips": "12081",
      "county": "MANATEE",
      "state": "FL",
      "category": "loan",
      "recordType": "Primary Record",
      "recordingDate": "2014-08-22T00:00:00.000Z",
      "recordingBookNumber": "2533",
      "recordingPageNumber": "4004",
      "documentTypeCode": 90,
      "documentType": "Deed of Trust/Mortgage",
      "documentDate": "2014-07-31T00:00:00.000Z",
      "signatureDate": null,
      "effectiveDate": null,
      "buyerVesting": null,
      "buyerMultiVesting": null,
      "partialInterestTransfer": null,
      "partialInterestTransferPercent": null,
      "salesPrice": null,
      "cityTransferTax": null,
      "countyTransferTax": null,
      "stateTransferTax": null,
      "totalTransferTax": null,
      "intraFamilyTransfer": null,
      "transferTaxExempt": null,
      "borrowerVesting": 27,
      "lenderName": "LESLAW SRODEK ETAL",
      "titleCompanyName": null,
      "lenderType": "Private Party",
      "loanAmount": 459000,
      "loanAmountDescription": "Aggregate amount (multiple loans with an aggregate total provided)",
      "maxLoanAmount": null,
      "loanTypeCode": 3,
      "loanClosedOrOpenEndedCode": null,
      "loanRateTypeCode": 4,
      "loanDueDate": "2024-08-01T00:00:00.000Z",
      "loanTermMonths": 119,
      "loanTermYears": null,
      "initialInterestRate": 4,
      "unpaidBalance": null,
      "totalDelinquentAmount": null,
      "delinquentAsOfDate": null,
      "installmentAmount": null,
      "installmentDueDate": null,
      "origLoanAmount": null,
      "origLoanDocumentDate": null,
      "origLoanRecordingDate": null,
      "origLoanDocumentNumber": null,
      "occupancyStatus": null,
      "trusteeSaleNumber": null,
      "auctionAddress": "",
      "auctionDate": null,
      "startingBid": null,
      "buyerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "sellerName": [
        "TOM JONES"
      ],
      "parcels": [
        {
          "apn": "18683.0545-7",
          "fips": "12081",
          "full": "999 TEST DR SARASOTA FL 34243",
          "house": "999",
          "houseExt": null,
          "streetPre": null,
          "street": "TEST",
          "streetSuffix": "DR",
          "streetPost": null,
          "unitType": null,
          "unit": null,
          "city": "SARASOTA",
          "state": "FL",
          "zip": "34243",
          "zip4": "4104",
          "coordinates": [
            -122.000001,
            47.600001
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/281444018"
    },
    {
      "id": "38301644",
      "parcelID": "4721322",
      "fips": "04013",
      "county": "MARICOPA",
      "state": "AZ",
      "category": "foreclosure",
      "recordType": "Primary Record",
      "recordingDate": "2010-05-04T00:00:00.000Z",
      "recordingBookNumber": null,
      "recordingPageNumber": null,
      "documentTypeCode": 95,
      "documentType": "Notice of Sale (Trustee Sale, Sheriff Sale or Foreclosure Sale)",
      "documentDate": "2010-05-03T00:00:00.000Z",
      "signatureDate": null,
      "effectiveDate": null,
      "buyerVesting": null,
      "buyerMultiVesting": null,
      "partialInterestTransfer": null,
      "partialInterestTransferPercent": null,
      "salesPrice": null,
      "cityTransferTax": null,
      "countyTransferTax": null,
      "stateTransferTax": null,
      "totalTransferTax": null,
      "intraFamilyTransfer": null,
      "transferTaxExempt": null,
      "borrowerVesting": null,
      "lenderName": null,
      "titleCompanyName": null,
      "lenderType": null,
      "loanAmount": null,
      "loanAmountDescription": null,
      "maxLoanAmount": null,
      "loanTypeCode": null,
      "loanClosedOrOpenEndedCode": null,
      "loanRateTypeCode": null,
      "loanDueDate": null,
      "loanTermMonths": null,
      "loanTermYears": null,
      "initialInterestRate": null,
      "unpaidBalance": 93117,
      "totalDelinquentAmount": 939,
      "delinquentAsOfDate": "2010-02-01T00:00:00.000Z",
      "installmentAmount": null,
      "installmentDueDate": null,
      "origLoanAmount": 100000,
      "origLoanDocumentDate": null,
      "origLoanRecordingDate": "2006-12-12T00:00:00.000Z",
      "origLoanDocumentNumber": "2006-1620705",
      "occupancyStatus": null,
      "trusteeSaleNumber": null,
      "auctionAddress": "1850 N CENTRAL AVE, STE 1140 PHOENIX",
      "auctionDate": "2010-08-06T00:00:00.000Z",
      "startingBid": null,
      "buyerName": [
        "JANE DOE",
        "JOE SMITH"
      ],
      "sellerName": [
        "TOM JONES"
      ],
      "parcels": [
        {
          "apn": "219-38-004M",
          "fips": "04013",
          "full": "999 N TEST DR GOODYEAR AZ 85338",
          "house": null,
          "houseExt": null,
          "streetPre": null,
          "street": null,
          "streetSuffix": null,
          "streetPost": null,
          "unitType": null,
          "unit": null,
          "city": "GOODYEAR",
          "state": "AZ",
          "zip": "85338",
          "zip4": null,
          "coordinates": [
            -122.000001,
            47.600001
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/38301644"
    }
  ]
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/transactions
Getting Response
Response Status
Response Body
Your Response Here

GET

/pub/transactions/maps

Description

Retrieves map coordinates for transactions. Allows for high limit queries as high as 10,000


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).

Response

Name
Type
Description
coordinates
[number]
The longitude and latitude associated with the property in the listing.
id
string
Unique ID generated by Retsly to identify the listing.
url
string
URL to find details for the specific listing.

Example Code

Example URL
https://rets.io/api/v1/pub/transactions/maps?access_token=6baca547742c6f96a6ff71b138424f21&limit=5
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "id": "999",
      "parcels": [
        {
          "coordinates": [
            -118.194803,
            34.854806
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/999"
    },
    {
      "id": "998",
      "parcels": [
        {
          "coordinates": [
            -119.949328,
            35.712137
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/998"
    },
    {
      "id": "997",
      "parcels": [
        {
          "coordinates": [
            -119.449328,
            35.727137
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/997"
    },
    {
      "id": "996",
      "parcels": [
        {
          "coordinates": [
            -118.926817,
            35.40863
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/996"
    },
    {
      "id": "995",
      "parcels": [
        {
          "coordinates": [
            -117.677523,
            35.628337
          ]
        }
      ],
      "url": "https://rets.io/api/v1/pub/transactions/995"
    }
  ],
  "total": 5
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/pub/transactions/maps
Getting Response
Response Status
Response Body
Your Response Here

/puid

Description

Retrieves links relating to a puid.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
offset
number
Skips this number of results.
limit
number
Limits the size of the result set.
sortBy
string
Response field to sort query by.
order
string
Order of responses: "asc/desc".
fields
string
Filters Response fields eg. fields=id,price.
near
string
Coord or location eg. near=-73.98,40.73 or near=San Diego.
radius
string
Search Radius in miles, km, or degrees (no units).
box
string
Coordinates representing a box eg. box=-112.5,33.75,-123,39
poly
string
Minimum 3 pairs of coordinates representing a polygon eg. poly=-112.5,33.75,-123,39,-120,38
geohash
string
Alphanumeric geohash eg. geohash=ezs42

Response

Name
Type
Description
id
number
Unique ID to identify the parcel.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
landUseDescription
string
Description that matches the land use code.
zoningCode
string
Municipality-specific zoning code indicates what part of the zoning or land use bylaw applies to this parcel.
zoningDescription
string
Short description of zoning code.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
lotSizeFrontage
number
Distance in feet between the front of the building and the property boundary
lotSizeDepth
number
Average depth of lot perpendicular to frontage.
lotSizeIrregular
string
Perimeter measurements for non-rectangular shaped lots.
lotTopography
string
Short description of lot topography.
numberOfBuildings
number
Number of buildings included in the parcel.
ownerName
[string]
Full names of the parcel owners.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
building.noOfUnits
number
The total number of units in the building if applicable.
building.occupancyStatus
string
The occupancy status of the building.
building.class
string
The class of the building.
building.quality
string
The quality of the building.
building.condition
string
The condition of the building.
building.architecturalStyle
string
The architectural style of the building.
building.heating
string
Heating feature of the building.
building.airConditioning
string
Air conditioning feature of the building.
building.foundation
string
Foundation feature of the building.
building.fireplace
string
Fireplace feature of the building.
building.water
string
Water source of the building.
building.sewer
string
Sewer or septic features of the building.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.kitchens
number
The total number of kitchens in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.comments
string
Comments about the building.
building.classDescription
string
Description of the building's class.
address.full
string
Full address.
address.city
string
City name.
address.house
string
House number.
address.houseExt
string
House number extension.
address.state
string
State name.
address.street
string
Street name.
address.streetPost
string
Additional street information.
address.streetPre
string
Street prefix.
address.streetSuffix
string
Street suffix.
address.unit
string
Unit number.
address.unitType
string
Unit type.
address.zip
string
Postal code.
address.zip4
string
Zip4.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.

Example Code

Example URL
https://rets.io/api/v1/puid?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": {
    "PUID": "US0611500910001687",
    "parcelID": "1000",
    "parcelUrl": "https://dev.rets.io/api/v1/pub/parcels/1000",
    "transactionsUrl": "https://dev.rets.io/api/v1/pub/parcels/1000/transactions",
    "assessmentsUrl": "https://dev.rets.io/api/v1/pub/parcels/1000/assessments",
    "mlsListings": [
      {
        "mlsListingID": "hjsdfsk",
        "url": "https://dev.rets.io/api/v1/undefined/hjsdfsk"
      }
    ]
  },
  "total": 1
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/puid
Getting Response
Response Status
Response Body
Your Response Here

GET

/puid/{puid}

Description

Retrieves links relating to a puid.


Request

Required fields
Name
Type
Description
access_token
string
Token to identify the user or application.
puid
string
puid

Response

Name
Type
Description
id
number
Unique ID to identify the parcel.
apn
string
Assessor Parcel Number, the unique identifier assigned by the tax authority.
fips
string
Five digit county code ID.
county
string
County name.
state
string
Two character state abbreviation.
landUseGeneral
string
Two character land use code (example: "RR" for Residential, "AG" for Agricultural).
landUseCode
string
Five character code describing this parcel's land use type.
landUseDescription
string
Description that matches the land use code.
zoningCode
string
Municipality-specific zoning code indicates what part of the zoning or land use bylaw applies to this parcel.
zoningDescription
string
Short description of zoning code.
lotSizeAcres
number
Size of the lot in acres.
lotSizeSquareFeet
number
Size of the lot in square feet.
lotSizeFrontage
number
Distance in feet between the front of the building and the property boundary
lotSizeDepth
number
Average depth of lot perpendicular to frontage.
lotSizeIrregular
string
Perimeter measurements for non-rectangular shaped lots.
lotTopography
string
Short description of lot topography.
numberOfBuildings
number
Number of buildings included in the parcel.
ownerName
[string]
Full names of the parcel owners.
coordinates
[number]
Longitude and latitude coordinates, eg. [-122.441, 37.717].
building.noOfUnits
number
The total number of units in the building if applicable.
building.occupancyStatus
string
The occupancy status of the building.
building.class
string
The class of the building.
building.quality
string
The quality of the building.
building.condition
string
The condition of the building.
building.architecturalStyle
string
The architectural style of the building.
building.heating
string
Heating feature of the building.
building.airConditioning
string
Air conditioning feature of the building.
building.foundation
string
Foundation feature of the building.
building.fireplace
string
Fireplace feature of the building.
building.water
string
Water source of the building.
building.sewer
string
Sewer or septic features of the building.
building.yearBuilt
number
The year in which the building was built.
building.effectiveYearBuilt
number
The year in which the building was efficively built.
building.totalStories
number
The total number of stories in the building.
building.totalRooms
number
The total number of rooms in the building.
building.bedrooms
number
The total number of bedrooms in the building.
building.kitchens
number
The total number of kitchens in the building.
building.fullBaths
number
The total number of full baths in the building.
building.baths
number
The total number of baths in the building.
building.comments
string
Comments about the building.
building.classDescription
string
Description of the building's class.
address.full
string
Full address.
address.city
string
City name.
address.house
string
House number.
address.houseExt
string
House number extension.
address.state
string
State name.
address.street
string
Street name.
address.streetPost
string
Additional street information.
address.streetPre
string
Street prefix.
address.streetSuffix
string
Street suffix.
address.unit
string
Unit number.
address.unitType
string
Unit type.
address.zip
string
Postal code.
address.zip4
string
Zip4.
legal.lotDescription
string
The lot description.
legal.lot
string
The lot.
legal.otherLot
string
The other lot.
legal.block
string
The block.
legal.subdivisionName
string
The name of the subdivision.
legal.unit
string
The unit.
legal.section
string
The section.
legal.phase
string
The phase.
legal.tract
string
The tract.
legal.district
string
The name of the district.
legal.municipality
string
The name of the municipality.
legal.city
string
The name of the city.
legal.township
string
The name of the township.
areas.type
string
Type of areas.
areas.areaSquareFeet
number
Area in square feet.

Example Code

Example URL
https://rets.io/api/v1/puid/1000?access_token=6baca547742c6f96a6ff71b138424f21&limit=1
Example Response
{
  "success": true,
  "status": 200,
  "bundle": [
    {
      "PUID": "US0611500910001687",
      "parcelID": "53092",
      "parcelUrl": "https://dev.rets.io/api/v1/pub/parcels/53092",
      "transactionsUrl": "https://dev.rets.io/api/v1/pub/parcels/53092/transactions",
      "assessmentsUrl": "https://dev.rets.io/api/v1/pub/parcels/53092/assessments"
    },
    {
      "PUID": "US0611500910004533",
      "parcelID": "2341",
      "parcelUrl": "https://dev.rets.io/api/v1/pub/parcels/2341",
      "transactionsUrl": "https://dev.rets.io/api/v1/pub/parcels/2341/transactions",
      "assessmentsUrl": "https://dev.rets.io/api/v1/pub/parcels/2341/assessments"
    }
  ],
  "total": 1
}

Parameters

Required fields

Custom queries

Add Query
Get Response

Response

curl https://rets.io/api/v1/puid/{puid}
Getting Response
Response Status
Response Body
Your Response Here
  • API RESPONSE TIME:loading...
  • API ERROR RATE:loading...