Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.realie.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
About the Realie CLI

The Realie CLI lets you access property data, manage API keys, and monitor usage directly from the terminal. It’s designed for both interactive use and autonomous operation by AI coding agents like Claude Code, Cursor, and Copilot. Every command outputs human-readable text by default, with a --json flag for machine-parseable output.

​
Install

​
Quick Start

1

Authenticate

Run realie login to open your browser and sign in:
realie login
This opens app.realie.ai in your browser. Sign in with your Realie account, confirm the code shown in the terminal, and you’re authenticated.For CI/CD or AI agents, pass an API key directly:
realie login --api-key YOUR_API_KEY
2

Look up a property

realie lookup --address "504 LAVACA ST" --state TX --county TRAVIS
3

Check your usage

realie usage

​
Commands

​
Authentication

CommandDescription
realie loginSign in via browser (OAuth) or --api-key for direct auth
realie logoutRemove stored credentials
realie whoamiShow current authenticated user and plan

​
Property Data

CommandDescription
realie lookup --address "..." --state TXLook up a property by address
realie search --state TX --county DENTON --limit 10Search properties using the full /api/public/property/search filter set
realie owner --last-name "..." --state TXSearch properties by owner name
realie comparables --latitude 30.2 --longitude -97.7Find comparable properties near a location
realie parcel --parcel-id "R12345" --state TX --county TRAVISLook up a property by parcel ID
realie location --latitude 30.2 --longitude -97.7Search nearby properties

​
Account Management

CommandDescription
realie usageShow API token usage for current billing period
realie keys listShow your current API key
realie keys regenerateGenerate a new API key

​
Utilities

CommandDescription
realie docs [search]Search Realie documentation
realie config listShow CLI configuration
realie config set <key> <value>Set a config value (baseUrl, defaultState)
realie statusCheck API health and latency
realie versionShow CLI version and environment info
realie upgradeUpgrade to the latest CLI version

​
JSON Mode

Add --json to any command for machine-readable output. This is what AI agents and scripts should use. 
# Human-readable (default)
realie usage
# Plan: Enterprise 1 (yearly)
# Period: Mar 29, 2026 – Mar 29, 2027
# API Tokens: ░░░░░░░░░░░░░░░░░░░░ 6 / 1,200,000 (0.0%)

# Machine-readable
realie --json usage

{
  "plan": "Enterprise 1",
  "planId": "apiEnterprise1",
  "billingPeriod": { "start": "2026-03-29", "end": "2027-03-29", "interval": "yearly" },
  "usage": { "apiCalls": 6, "apiTokens": 6, "baseTokens": 1200000 },
  "endpointBreakdown": { "property/address": 1, "premium/comparables": 4, "property/search": 1 },
  "overage": { "tokens": 0, "estimatedCost": "$0.00" }
}

​
API Parameter Parity

The API-backed property commands mirror their corresponding endpoint query parameters using kebab-case CLI flags.
  • realie lookup mirrors /api/public/property/address
  • realie search mirrors /api/public/property/search
  • realie owner mirrors /api/public/property/owner
  • realie parcel mirrors /api/public/property/parcelId
  • realie location mirrors /api/public/property/location
  • realie comparables mirrors /api/public/premium/comparables
Examples: 
realie search \
  --state WI \
  --county TAYLOR \
  --city WESTBORO \
  --zip-code 54451 \
  --include-unassigned-address true \
  --limit 25

realie comparables \
  --latitude 30.2672 \
  --longitude -97.7431 \
  --time-frame 12 \
  --beds-min 2 \
  --beds-max 4 \
  --price-min 300000 \
  --price-max 900000

realie location \
  --latitude 45.3090682 \
  --longitude -90.5608659 \
  --radius 0.05 \
  --include-unassigned-address true \
  --limit 10

​
Configuration

Config is stored at ~/.realie/config.json:
KeyDescriptionDefault
apiKeyYour API key (set via realie login)—
baseUrlAPI base URLhttps://app.realie.ai
defaultStateDefault state code for queries—
defaultFormatOutput format (json or pretty)pretty
You can also authenticate via the REALIE_API_KEY environment variable: 
REALIE_API_KEY=your_key realie whoami

​
For AI Agents

The CLI is designed for fully autonomous use by AI coding agents:
  • Browser login: realie login opens a browser for OAuth sign-in (interactive terminals)
  • Direct auth: realie login --api-key <key> or REALIE_API_KEY env var (non-interactive / CI)
  • JSON output: --json on every command for structured, parseable responses
  • Structured errors: { "error": "message", "code": "ERROR_CODE" } with exit code 1
  • Self-updating: realie upgrade checks for and installs new versions
Add to your CLAUDE.md or agent instructions:
Use the `realie` CLI to query property data.
Always pass --json for parseable output.
Authenticate with: realie login --api-key <key>