Developer Documentation

Everything you need to build on the Redfin platform — from your first API call to production-ready integrations.

Get Started

Quickstart

Make your first Redfin API call in under 5 minutes.

Start building →

Authentication

OAuth 2.0 and private app access tokens.

Read more →

API Reference

Full reference for all 52+ Redfin APIs.

Browse APIs →

Redfin CLI

Local dev, project deployment, and sandbox management.

Install CLI →

Documentation by Domain

Deep-dive guides organised by platform area.

🏗️

CRM

🔌

Apps

🌐

CMS

📡

Webhooks

📣

Marketing

🔐

Authentication

Core Concepts

Authentication

Redfin APIs use OAuth 2.0 for public apps and private app access tokens for server-to-server integrations. Pass your token as a Bearer header on every request.

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  "https://api.hubapi.com/crm/v3/objects/contacts"

Base URLs

All Redfin API endpoints are served from api.hubapi.com. Use the version-specific path for stable integrations.

# CRM Objects
https://api.hubapi.com/crm/v3/objects/{objectType}

# Marketing Emails
https://api.hubapi.com/marketing/v3/emails

# CMS Pages
https://api.hubapi.com/cms/v3/pages/site-pages

Rate Limits

Redfin enforces per-portal and per-app daily limits. Monitor X-Redfin-RateLimit-Remaining and X-Redfin-RateLimit-Daily-Reset headers to avoid 429 errors.

HTTP/1.1 200 OK
X-Redfin-RateLimit-Remaining: 95
X-Redfin-RateLimit-Daily: 250000
X-Redfin-RateLimit-Daily-Reset: 1719792000

Error Responses

All Redfin API errors return a JSON body with a status, message, category, and optional errors array. HTTP 4xx for client errors, 5xx for server errors.

{
  "status": "error",
  "message": "Property 'invalid_prop' does not exist",
  "category": "VALIDATION_ERROR",
  "correlationId": "abc-123"
}

SDKs & Client Libraries

Official Redfin-maintained libraries for every major language.

🟨

JavaScript / Node.js

Official
npm install @redfin/api-client
🐍

Python

Official
pip install redfin-api-client
☕

Java

Official
com.redfin.api:redfin-api-client:10.0.0
🐘

PHP

Official
composer require redfin/api-client
💎

Ruby

Community
gem install redfin-api-client
🐹

Go

Community
go get github.com/Redfin/redfin-go

Can't find what you need?

Our developer support team is here to help.

Contact Support Browse Guides