What's the API?

The API (Application Programming Interface) frees you to use Honest Renter's system without having to be on our website. You can fetch, add, or modify information in our database from any web-enabled computer or server. This means that you can include Honest Renter's tests on your own websites, or display results in your own customized reports.

Who can use it?

Anyone. There's nothing to download. All you need is an Honest Renter account, and to let us know which domains to authorize.

Property management companies: Branding is important. There are good reasons for wanting prospective tenants to complete all application materials on your own website. Honest Renter's API gives you full control over the look, feel, and location of materials.

Tenant screening companies & property management software companies: Want to add personality tests to your list of services? As a certified reseller/distributor of Honest Renter products, you have complete control of the tenant and landlord experience. White labeling is also available, allowing you to re-brand Honest Renter's products to truly make them your own.

Intro to Honest Renter's API

REST: Our API is organized around REST. We use predictable, resource-oriented URLs. HTTP response codes indicate API errors. Cross-origin resource sharing (CORS) allows secure interaction with our API from any browser or server. All requests return standard JSON for easy parsing, even for error messages. Objects are also expandable, allowing you to retrieve chained objects in a single API call.

Live example: Us! We're our own client. Every interaction between our website and database is done through the API. If we can do it, so can you! To recreate the functionality of any page, simply copy that page's front end code (HTML, JavaScript, CSS files) to your own website.

How to get started: First, let us know your website's domain name. We'll add your website to the list of sites allowed to make API requests. You then have 2 options:

  1. Build your own application from scratch.
  2. Copy our front end code. For example, administering the personality test is as simple as copying the personality page and its .js and .css files to your website. You can then tailor the material to the look and feel of your website, and modify them to suit your purpose.

Full API Documentation

Click on any object to see a list of its properties and methods,
as well as sample code for interacting with the object.

General Principles

Login authentication Secret key authentication Authorization Save session to browser Errors
Expanding objects Filters for fetching objects Specify fields to return Versioning Changelog

Assessment-related objects

A password is required to view the documentation for assessment-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.

Administration Assessment Assessment type Change Completion Condition Field Invitation Invitation method type Item
Itemset Item order Language Language Scope Language Type Motivation Norm Option Optionset Response
Response format Result Scale Scale order Score Step Stimulus Study Viewing Weight Weighting scheme

Person-related objects

A password is required to view the documentation for person-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.

Applicant Candidate Child Code Cooccupant Country code Credit Report Settings Drivers license Email Emergency contact Ethnicity Failed login Gender Inbox filters
Invite settings Member Name National identification National identification Type Notification Notification type Organization Participant Person Pet Pet age category Pet size category Pet type
Phone Position Reason for archive Reason for eviction Reason for exclusion Relationship type Reminder Residence Smoking status category Sort by option Time of day Title User Vehicle Phone type

Account-related objects

A password is required to view the documentation for account-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.

Account Account status category Area Building type Client Client authorization Continent Coordinate
Country Email template Email template type File File type File type category Locality Location Location authorization
Note Permission PermissionLevel Postal code Resource Role SMTP Unit Unit characteristic type

Billing-related objects

Our payment provider is Stripe.
Most of the billing-related objects listed below mirror objects defined in Stripe's API.

A password is required to view the documentation for billing-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.

Card Charge Coupon Credit price Credit transaction Currency
Customer Discount Dispute Event Invoice Invoice item
Invoice line item Plan Recipient Subscription Tax Taxation

Ruby Gem

This api has a Ruby gem! The library can be found here on Github, with the actual gem hosted on RubyGems.org.

Currently the gem is ready only, not supporting creation paths for any models. It does support authentication and different types of queryable interfaces.

Credit for the gem belongs to Jake Yesbeck.