Quick Start Guide

Overview

PropTechUSA provides a suite of tools and APIs for building real estate technology applications. This guide will get you up and running quickly.

Prerequisites

Before you begin, make sure you have:

• Node.js 18+ installed
• A PropTechUSA API key (get one here)
• Basic familiarity with JavaScript/TypeScript

Step 1: Install the SDK

npm install @proptechusa/sdk

Or with yarn:

yarn add @proptechusa/sdk

Step 2: Initialize the Client

import { PropTech } from '@proptechusa/sdk';

const client = new PropTech({
  apiKey: process.env.PROPTECH_API_KEY,
});

Step 3: Make Your First Request

// Fetch all leads
const leads = await client.leads.list();
console.log(leads);

// Create a new lead
const newLead = await client.leads.create({
  name: 'John Doe',
  email: 'john@example.com',
  phone: '555-1234',
  source: 'website',
});

Next Steps

• Installation & Setup - Detailed installation instructions
• Authentication - Learn about API authentication
• API Reference - Explore all available endpoints