Getting Started

Through the API, connected systems can submit property information to TPX, synchronize existing records and make selected inventory available for syndication across participating websites.

TPX is designed specifically for private property networks. API access is therefore controlled. Every connection is associated with an authorized TPX organization and authenticated using credentials issued specifically for that integration.

How the TPX API Works

A connected property system communicates with the central TPX platform through authenticated API requests.

An agency using Houzez, for example, can continue creating and managing properties normally within WordPress. The TPX Houzez Connector communicates with the TPX API and synchronizes selected property information with the central platform.

TPX then maintains the canonical property record used by the private network. Properties made available to the network can be syndicated by other authorized participants, while the originating agency remains associated with the authoritative property record.

YOUR PROPERTY SYSTEM
        ↓
      TPX API
        ↓
CANONICAL PROPERTY RECORD
        ↓
 PRIVATE TPX NETWORK

API Access

Access to the TPX API requires credentials issued for an authorized integration.

Each API client is associated with a TPX agency or organization and receives its own authentication credentials.

X-TPX-Client-ID
Identifies the API client making the request.

X-TPX-Secret
Authenticates that client with TPX.

These credentials must be included when accessing protected TPX API endpoints.

API credentials should always be stored securely on the server. They should never be exposed in public JavaScript, HTML or other client-side code.

Authentication

Protected TPX API requests include the integration credentials within the HTTP request headers.

X-TPX-Client-ID: YOUR_CLIENT_ID
X-TPX-Secret: YOUR_CLIENT_SECRET
Accept: application/json
Content-Type: application/json

TPX validates the credentials and verifies that both the API client and its associated organization are authorized to access the network.

If authentication fails, the API rejects the request before any property information is processed.

Test Your Connection

Before synchronizing property information, developers should confirm that communication with TPX is working correctly.

GET /api/auth-test

A successful response confirms that the credentials have been accepted and that the external system can communicate with the TPX server.

This should normally be the first API request made when configuring a new integration.

Your First Property Request

The primary property synchronization endpoint is:

POST /api/v1/properties/sync

This endpoint allows an authenticated system to submit property information to TPX.

{
  "external_id": "PROPERTY-1001",
  "title": "Modern Sea View Villa",
  "status": "for-sale",
  "sale_price": 6250000,
  "exchange_available": true
}

The actual property payload can contain additional information depending on the property and integration.

TPX uses the external property identifier together with the authenticated source to determine whether the request represents a new property or an update to an existing property.

Creating and Updating Properties

The synchronization endpoint supports both initial property creation and subsequent updates.

FIRST SYNCHRONIZATION

Website Property #1001
          ↓
    TPX Property #4831
         CREATED

LATER SYNCHRONIZATION

Website Property #1001
          ↓
    TPX Property #4831
         UPDATED

The TPX Property ID remains associated with the same canonical property throughout its lifecycle.

Making a Property Available to the Network

Synchronizing a property with TPX does not automatically mean that other members can syndicate it.

Network availability is controlled separately.

{
  "exchange_available": true
}

To withdraw the property from network availability:

{
  "exchange_available": false
}

Canonical Property Records

TPX operates around the concept of a canonical property record.

                TPX PROPERTY #4831
                        │
              CANONICAL RECORD
                        │
          ┌─────────────┼─────────────┐
          ↓             ↓             ↓
      AGENCY A      AGENCY B      AGENCY C

The source organization remains associated with the canonical property, while separate syndication records determine which network members distribute it.

Property Identification

Every external system should maintain a persistent identifier for each property synchronized with TPX.

SOURCE SYSTEM ID
PROPERTY-1001
       ↓
TPX PROPERTY ID
4831

API Responses

TPX endpoints return structured JSON responses.

{
  "status": "success",
  "action": "updated",
  "property": {
    "id": 4831
  }
}

Errors & Validation

TPX validates incoming requests before accepting property information.

• Invalid or missing API credentials
• Missing required property information
• Invalid field values
• Insufficient authorization
• A suspended API client
• An inactive associated organization
• Invalid property data

{
  "status": "error",
  "message": "Authentication failed"
}

Integration Options

Development to Production

API CREDENTIALS
      ↓
TEST CONNECTION
      ↓
SYNC TEST PROPERTY
      ↓
VERIFY TPX RECORD
      ↓
TEST UPDATE
      ↓
ENABLE NETWORK
      ↓
PRODUCTION