Rent History: API Documentation

Unmask Associated Entities

Endpoint: https://renthistory.org/datasets/unmask.php

Required Field:

• corporationname (string) - The name of the corporation to search for.

Required Headers:

• X-API-KEY (string) - A valid API key.

Example Usage

cURL:

curl -G "https://renthistory.org/datasets/unmask.php" \
     -H "X-API-KEY: YOUR_API_KEY_HERE" \
     --data-urlencode "corporationname=Example Corp"
        

Python (requests):

import requests

url = "https://renthistory.org/datasets/unmask.php"
params = {"corporationname": "Example Corp"}
headers = {"X-API-KEY": "YOUR_API_KEY_HERE"}

response = requests.get(url, params=params, headers=headers)
print(response.json())
        

Response Format

Success:

{
  "entityNames": [
    "Example Holdings LLC",
    "Example Management Corp"
  ]
}
        

Errors:

{
  "error": "Invalid or missing API key."
}
        

{
  "error": "The 'corporationname' parameter is required."
}
        

{
  "error": "No registration contacts found for the specified corporation name."
}
        

Consolidate Landlord Info

Endpoint: https://renthistory.org/datasets/landlord_consolidate.php

Required Fields:

• firstname (string) – The landlord's first name.
• lastname (string) – The landlord's last name.

Required Headers:

• X-API-KEY (string) – Your valid API key.

Example Usage

cURL:

curl -G "https://renthistory.org/datasets/landlord_consolidate.php" \
     -H "X-API-KEY: YOUR_API_KEY" \
     --data-urlencode "firstname=John" \
     --data-urlencode "lastname=Doe"
        

Python (requests):

import requests

url = "https://renthistory.org/datasets/landlord_consolidate.php"
params = {"firstname": "John", "lastname": "Doe"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers)
print(response.json())
        

Case Insensitive Registration Contact

Endpoint: https://renthistory.org/datasets/registration_contacts.php

Fields:

• registrationcontactid
• registrationid
• type
• contactdescription
• corporationname
• title
• firstname
• middleinitial
• lastname
• businesshousenumber
• businessstreetname
• businessapartment
• businesscity
• businessstate
• businesszip

Required Headers:

• X-API-KEY (string) – Your valid API key.

Example Usage

cURL:

curl -G "https://renthistory.org/datasets/registration_contacts.php" \
     -H "X-API-KEY: YOUR_API_KEY" \
     --data-urlencode "registrationcontactid=12345"
        

Python (requests):

import requests

url = "https://renthistory.org/datasets/registration_contacts.php"
params = {"registrationcontactid": "12345"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers)
print(response.json())
        

Registration

Endpoint: https://renthistory.org/datasets/registration.php

Fields:

• registrationid
• buildingid
• boroid
• boro
• housenumber
• lowhousenumber
• highhousenumber
• streetname
• streetcode
• zip
• block
• lot
• bin
• communityboard
• lastregistrationdate
• registrationenddate

Required Headers:

• X-API-KEY (string) – Your valid API key.

Example Usage

cURL:

curl -G "https://renthistory.org/datasets/registration.php" \
     -H "X-API-KEY: YOUR_API_KEY" \
     --data-urlencode "registrationid=67890"
        

Python (requests):

import requests

url = "https://renthistory.org/datasets/registration.php"
params = {"registrationid": "67890"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers)
print(response.json())