Introduction

Welcome to the Athause Developer Documentation. Our platform provides the headless infrastructure necessary for real estate agencies to programmatically scale and manage property portfolios globally.

Built strictly for performance and multi-tenancy, our endpoints act as the primary global server tracking points for your portfolio. We decouple complex database middleware entirely—enabling you to ingest clean, structured listings directly into your custom storefronts, CRMs, and partner networks instantly.

Authentication

Athause uses standard HTTP Bearer token authentication to securely handle requests. API keys operate on a workspace level and can be managed directly from your developer dashboard.

To authenticate your requests, you must pass your active token in the Authorization header using the exact Bearer schema. Failing to pass a valid token or passing a revoked token will return a strict 401 Unauthorized block.

Security Notice

Although property information is publicly visible through your agency frontend, you must ensure your Athause API Key never leaks. Always make requests to the Athause API from your secure server-side infrastructure and never directly from the client/browser frontend. This strict requirement is in place for the mutual protection of your agency and our global network.

Request Header Protocol

Authorization: Bearer atk_live_8f2a1b9c8d7e6f5...

Property Schema

The core entity within the Athause architecture is the Property object. This schema represents the comprehensive details of a listing, spanning fundamental attributes, pricing, and exact geographic coordinates.

Property Fields Dictionary

id
string (uuid)
The unique identifier for the property.
status
string
Current status of the listing (e.g., published, draft, archived).
title
string
The marketing headline or title of the property.
location
object | null
Geographic bounds or localized region data.
price
number
The listing price in the agency's default currency.
attributes
object
Dynamic key-value pairs of property amenities and features (e.g., Bedrooms, Heating).
gross_area
number
Total constructed area.
usable_area
number
Net livable/usable area inside the property.
description
string
Full marketing description text.
type
string
The architectural categorization (e.g., apartment, house, commercial).
street_address
string
The main street-level address string.
unit_number
string | null
The specific apartment or suite identifier.
city
string
The city or municipality.
state_province
string
The region, state, or province.
postal_code
string
The postal or zip code.
country
string
The two-letter ISO country code.
latitude
number | null
Geographic latitude coordinate.
longitude
number | null
Geographic longitude coordinate.
main_image_url
string | null
Direct URL to the primary high-resolution hero image.

Agency Preferences

The Agency Preferences object defines the localized settings applied universally across your workspace. It ensures that prices and architectural measurements returned by the API adhere to the specific standards of your agency's operating region.

Agency Preferences Dictionary

currency_code
string
The primary currency used by the agency for all financial transactions (e.g., "USD", "EUR").
area_unit
string
The standard measurement unit for calculating gross and usable property areas (e.g., "sqm", "sqft").

Version 1 Endpoints

Current API

Standard Response Envelope

All API responses are wrapped in a standard JSON envelope. This guarantees a consistent structure containing the request's success status, the core data payload (which may be a collection or a single entity), and essential metadata including your agency's regional preferences and pagination details.

Response SchemaJSON

{
  "success": boolean,
  "data": array of json objects || single json object,
  "metadata": {
    "agency_preferences": {
      "currency_code": "EUR" || "USD",
      "area_unit": "sqm" || "sqft"
    },
    "pagination": {
      "limit": number,
      "offset": number,
      "total_count": number
    }
  }
}

GET

/v1/properties

Retrieves a paginated collection stream of properties managed by your active agency token. This acts as the standard lifecycle hub endpoint to extract your inventory array.

RequestJavaScript

const response = await fetch('https://api.athause.com/v1/properties', {
  headers: {
    'Authorization': 'Bearer atk_live_...'
  }
});

const data = await response.json();

Response

200 OK

{
  "success": true,
  "data": [
    {
      "id": "prop_8f2a1b",
      "title": "Urban Heights Apartment",
      "price": 795000,
      "type": "apartment",
      "status": "published"
    }
  ],
  "metadata": {
    "pagination": {
      "limit": 10,
      "offset": 0
    }
  }
}

GET

/v1/properties/[id]

Triggers a precise target lookup to fetch comprehensive architectural, transactional, and locational details for a specific property instance.

RequestJavaScript

const propertyId = 'prop_8f2a1b';
const response = await fetch(
  `https://api.athause.com/v1/properties/${propertyId}`, 
  {
    headers: {
      'Authorization': 'Bearer atk_live_...'
    }
  }
);

const data = await response.json();

Response

200 OK

{
  "success": true,
  "data": {
    "id": "prop_8f2a1b",
    "title": "Urban Heights Apartment",
    "price": 795000,
    "type": "apartment",
    "status": "published",
    "attributes": {
      "bedrooms": 2,
      "bathrooms": 2,
      "area_sqft": 1250
    },
    "location": {
      "city": "New York",
      "neighborhood": "Tribeca"
    }
  }
}