Tenant Evictions
tenant-evictions-search
GET /tenant-evictions/search
Tenant Evictions search
Search entities in the Tenant Evictions list
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
full_name | query | string | false | Full name or alias |
street | query | string | false | Street address |
unit | query | string | false | Unit number |
postal_code | query | string | false | Zip or postal code |
country_code | query | string | false | Country code (e.g. US) |
state_code | query | string | false | State or province code (e.g. CA) |
sources | query | string | false | Comma-separated list of sources to search (default: all) |
from | query | number | false | Pagination start (default: 0) |
x-api-key | header | string | true | API Authentication Key |
Example responses
Lookup results object
{
"items": [
{
"source": "us-ny",
"source_url": "https://www.nycourts.gov/courts/nyc/housing/holdover.shtml",
"eviction_address": "123 Main St",
"eviction_zip": "10001",
"eviction_date": "2020-01-01",
"case_number": "123456",
"location": {
"geo": {
"lat": 40.7128,
"lon": -74.006
},
"street": "123 Main St",
"unit": "Apt 1",
"city": "New York",
"state_name": "New York",
"country_name": "United States",
"postal_code": "10001"
}
}
]
}
500 Response
{
"error": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Lookup results object | LookupEvictionsResponse |
500 | Internal Server Error | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.get('https://data.autohost.ai/v1/tenant-evictions/search', headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const headers = {
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/tenant-evictions/search', {
method: 'get',
headers,
});
const responseJson = await response.json();
console.log(responseJson);
tenant-evictions-sources
GET /tenant-evictions/sources
Tenant Evictions sources
Retrieve a list of sources available in the Tenant Evictions list
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
x-api-key | header | string | true | API Authentication Key |
Example responses
Lookup results object
{
"sources": [
"us-ny",
"us-sf",
"us-dc",
"us-md",
"ca-on"
]
}
500 Response
{
"error": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Lookup results object | LookupEvictionsSourcesResponse |
500 | Internal Server Error | An error message | ErrorResponse |
Code samples
"""
Python Code Snippet
"""
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'string'
}
r = requests.get('https://data.autohost.ai/v1/tenant-evictions/sources', headers=headers)
print(r.json())
/*
TypeScript Code Snippet
*/
import fetch from 'node-fetch';
const headers = {
'Accept':'application/json',
'x-api-key':'string'
};
const response = await fetch('https://data.autohost.ai/v1/tenant-evictions/sources', {
method: 'get',
headers,
});
const responseJson = await response.json();
console.log(responseJson);