{"endpoints":[{"id":1023,"name":"Address Autocomplete","order":1,"identifier":"auto_complete","credits":0,"url":"https://developers.homesage.ai/api/properties/auto-complete/","method":"GET","description":"\n

Search for property addresses with typeahead autocomplete suggestions. Returns matching address suggestions for a partial address string — ideal for building address search UIs.

\n

Credit Cost: Free (0 credits)

\n

Notes:

\n \n "},{"id":3,"name":"Property Info","order":2,"identifier":"info","credits":2,"url":"https://developers.homesage.ai/api/properties/info/","method":"GET","description":"\n

Comprehensive property information including listing details, valuation, features, history, and school ratings. This is the primary property data endpoint.

\n

Credit Cost: 2 credits per request

\n

Response includes:

\n \n

Note: Address format is flexible — commas, periods, and case variations all accepted.

\n

Some fields may be null when source data is incomplete: listing_price is null unless the property is for sale; estimated_value is null when no AVM has been computed; numeric fields under property_features may be null per-property.

\n "},{"id":1024,"name":"Updated Property Info","order":3,"identifier":"updated_info","credits":1,"url":"https://developers.homesage.ai/api/properties/updated-info/","method":"GET","description":"\n

Always-fresh property information. Same schema as Property Info but fetches the latest valuation data. Recommended over Property Info for most use cases — cheaper (1 credit vs 2) and returns a fresher estimated value.

\n

Credit Cost: 1 credit per request

\n

Tip: Calling this endpoint refreshes the cache that Property Info reads from. Call Updated Info first to ensure subsequent Property Info calls return fresh data.

\n

Same response schema as Property Info. Some fields may be null when source data is incomplete.

\n "},{"id":27,"name":"Property Search (Bulk)","order":4,"identifier":"bulk_property_info","credits":1,"url":"https://developers.homesage.ai/api/properties/bulk-info/","method":"GET","description":"\n

Search for properties by location with optional filters. Returns a paginated list of properties matching your criteria. This is a location-based search endpoint, not a batch address lookup.

\n

Credit Cost: 1 credit per property returned. A page of 50 properties costs 50 credits. Pass page_size explicitly to cap the cost of a call before it runs.

\n

Supported filters:

\n \n

Note: Use page_size to control results per page (default: 10, max: 100) and page for pagination.

\n

All 36 per-property fields are always present. Several may be null when underlying data has not been computed: avm, avm_low, avm_high, avm_confidence, avm_disagreement (computed by the comps refresh job), and final_property_condition, is_tlc, neighborhood (depend on per-property data availability).

\n "},{"id":1000,"name":"Square Footage Per Floor","order":5,"identifier":"sqft_per_floor","credits":1,"url":"https://developers.homesage.ai/api/properties/sqft-per-floor/","method":"GET","description":"\n

AI-powered square footage breakdown by floor. Uses a 7-stage analysis to determine per-floor square footage distribution.

\n

Credit Cost: 1 credit per request

\n

Note: Use a 45-second timeout for this endpoint.

\n "},{"id":1005,"name":"Current Property Estimate","order":6,"identifier":"current_estimate","credits":2,"url":"https://developers.homesage.ai/api/properties/current-estimate/","method":"GET","description":"\n

Current property value estimate powered by our valuation engine.

\n

Credit Cost: 2 credits per request

\n "},{"id":2,"name":"Investment Potential","order":7,"identifier":"investment_potential","credits":3,"url":"https://developers.homesage.ai/api/properties/investment_potential/","method":"GET","description":"\n

Investment potential score for a property.

\n

Credit Cost: 3 credits per request

\n "},{"id":1,"name":"Price Flexibility Score (PFS)","order":8,"identifier":"pfs","credits":2,"url":"https://developers.homesage.ai/api/properties/pfs/","method":"GET","description":"\n

Price Flexibility Score (PFS) — a composite score indicating how flexible the listing price is. Lower scores suggest the seller may be more open to price negotiation.

\n

Credit Cost: 2 credits per request

\n "},{"id":6,"name":"Home Value History","order":9,"identifier":"home_value_graph","credits":1,"url":"https://developers.homesage.ai/api/properties/home_value_graph/","method":"GET","description":"\n

Historical home value data points for charting. Returns monthly value estimates in reverse-chronological order (most recent first).

\n

Credit Cost: 1 credit per request

\n

Note: Data points are returned most-recent-first. Sort client-side if you need chronological order.

\n "},{"id":5,"name":"Flip Return Analysis","order":10,"identifier":"flip_return","credits":3,"url":"https://developers.homesage.ai/api/properties/flip_return/","method":"GET","description":"\n

Flip/resale return analysis including total project cost, profit, ROI, and maximum recommended renovation budget.

\n

Credit Cost: 3 credits per request

\n

Note: Requires property size (sqft) and price data in the database. Returns 400 for properties missing this data.

\n "},{"id":4,"name":"Renovation Return","order":11,"identifier":"renovation_return","credits":3,"url":"https://developers.homesage.ai/api/properties/renovation_return/","method":"GET","description":"\n

Rental income projections including daily/monthly/annual gross and net income, IRR, cap rate, NOI, and cash-on-cash return.

\n

Credit Cost: 3 credits per request

\n

Note: Requires property size (sqft) data. Returns 400 for properties without sqft in the database.

\n "},{"id":12,"name":"Renovation Cost Estimate","order":12,"identifier":"renovation_cost","credits":5,"url":"https://developers.homesage.ai/api/properties/renovation/cost/","method":"GET","description":"\n

Quick renovation cost estimate with value gap analysis. For detailed room-by-room breakdown, use the Renovation Cost Breakdown (POST) endpoint instead.

\n

Credit Cost: 5 credits per request

\n "},{"id":9,"name":"Needs TLC Check","order":13,"identifier":"tlc","credits":1,"url":"https://developers.homesage.ai/api/properties/tlc/","method":"GET","description":"\n

Quick check whether a property needs TLC (Tender Loving Care). Returns a simple boolean indicator.

\n

Credit Cost: 1 credit per request

\n "},{"id":10,"name":"Long-Term Rental Analysis","order":14,"identifier":"rental_long_term","credits":5,"url":"https://developers.homesage.ai/api/properties/rental/long_term/","method":"GET","description":"\n

Long-term rental income projections including daily/monthly/annual gross and net income, IRR, cap rate, NOI, and cash-on-cash return.

\n

Credit Cost: 5 credits per request

\n

Note: Requires property size (sqft) and price data.

\n "},{"id":11,"name":"Short-Term Rental Analysis","order":15,"identifier":"rental_short_term","credits":5,"url":"https://developers.homesage.ai/api/properties/rental/short_term/","method":"GET","description":"\n

Short-term (Airbnb-style) rental income projections including daily/monthly/annual revenue, cap rate, NOI, and cash flow.

\n

Credit Cost: 5 credits per request

\n "},{"id":14,"name":"Property Condition","order":16,"identifier":"property_condition","credits":2,"url":"https://developers.homesage.ai/api/properties/property-condition/","method":"GET","description":"\n

AI-powered property condition assessment. Returns a condition label derived from photo and listing-text analysis of the stored property record.

\n

Credit Cost: 2 credits per request

\n

Condition values: Excellent, Good, Outdated, Poor, Very Poor, Unpredictable

\n "},{"id":999,"name":"Property Condition with Custom Photos","order":17,"identifier":"property_condition_custom_photos","credits":3,"url":"https://developers.homesage.ai/api/properties/property-condition-custom-photos/","method":"POST","description":"\n

Advanced property condition analysis using custom photos. Combines database lookup with AI vision analysis of your property images for a more accurate assessment.

\n

Credit Cost: 3 credits per request

\n

Supports both GET and POST.

\n

Input modes:

\n \n "},{"id":15,"name":"Comparable Properties (Comps)","order":18,"identifier":"comps","credits":5,"url":"https://developers.homesage.ai/api/properties/comps/","method":"GET","description":"\n

Find comparable recently sold properties for valuation analysis. Returns up to 5 comparable properties with adjusted prices and confidence scores.

\n

Credit Cost: 5 credits per request

\n

Note: ARV (After Repair Value) may be null in non-disclosure states where sale prices are not publicly recorded.

\n "},{"id":1025,"name":"Market Outlook","order":19,"identifier":"market_outlook","credits":2,"url":"https://developers.homesage.ai/api/properties/market-outlook/","method":"GET","description":"\n

Local market outlook and trends for a ZIP code area. Returns market health indicators including outlook score, forecast bars, market velocity metrics, and source breakdown.

\n

Credit Cost: 2 credits per request

\n

Response shape notes

\n

When a signal is unavailable for a ZIP code, optional sections may be omitted from the response: outlook_score, forecast_bars, market_velocity, micro_stats, and source_breakdown.

\n

The fields zip_code, metro_name, timestamp, weights_used, and credits_charged are always present.

\n

Note: micro_stats.absorption_rate_pct and source_breakdown.local_transactions.absorption_rate express the same metric under two different field names. Both are populated from the same calculation; read either one.

\n "},{"id":1019,"name":"Solar & Roof Analysis","order":20,"identifier":"solar_analysis","credits":4,"url":"https://developers.homesage.ai/api/solar/analysis/","method":"GET","description":"\n

Comprehensive solar potential and AI-powered roof condition analysis. Returns panel recommendations, energy projections, cost savings, federal incentives, and roof condition assessment.

\n

Credit Cost: 4 credits per request

\n

Important: Use a 90-second client timeout. Cache responses — this is an expensive, slow endpoint.

\n

Response shape notes

\n

The response shape varies based on optional query parameters:

\n \n

If S3 image upload fails, roof_condition.imagery contains roof_image_base64 (raw base64 PNG) instead of roof_image_url. Individual entries in solar_layers may be missing if a particular data layer was unavailable for the address.

\n "},{"id":13,"name":"Full Property Report","order":21,"identifier":"full_report","credits":15,"url":"https://developers.homesage.ai/api/properties/full-report/","method":"GET","description":"\n

The most comprehensive property analysis endpoint. Aggregates data from 11 internal sources into a single response with 292 data fields. Costs 15 credits — 25% cheaper than calling individual endpoints separately (~20 credits).

\n

Credit Cost: 15 credits per request

\n

Includes:

\n \n

Does NOT include:

\n \n

This endpoint aggregates data from multiple internal sources. Sub-fields may be null, 0, or empty arrays when the underlying data is unavailable for the property — e.g., comps may be empty in rural areas, last_sold_price is 0 in non-disclosure states, and photos can be empty for unlisted properties.

\n "},{"id":1010,"name":"Renovation Cost Breakdown","order":22,"identifier":"advanced_renovation_cost_breakdown","credits":5,"url":"https://developers.homesage.ai/api/properties/renovation-cost-breakdown/","method":"POST","description":"\n

AI-powered room-by-room renovation cost breakdown with confidence scores, red flags, and non-visible area estimates. The most detailed renovation analysis available — 158 data fields.

\n

Credit Cost: 5 credits per request

\n

Input modes (provide one)

\n \n

At most 30 images are analyzed per request; extras are ignored. Analyses of your own photos always run fresh — they are never cached and never change the property's stored condition.

\n

Response includes:

\n \n

Response shape notes

\n

This endpoint is AI-powered, so a few fields vary by property:

\n \n

Cost values and text descriptions may vary slightly between calls for the same property. Structural keys and types remain consistent.

\n "},{"id":1026,"name":"Sold Properties by ZIP","order":26,"identifier":"sold_by_zip","credits":51,"url":"https://developers.homesage.ai/api/properties/sold/by-zip/","method":"GET","description":"\n

Retrieve all sold properties in a ZIP code area. Returns a full list of recently sold properties with details.

\n

Credit Cost: ~51 credits per request (scales with result count, ~0.05 per property)

\n

Important: This is the most expensive endpoint. Use limit to cap results, or call Sold Properties Count first to estimate cost.

\n "},{"id":1027,"name":"Sold Properties Count","order":27,"identifier":"sold_count_by_zip","credits":1,"url":"https://developers.homesage.ai/api/properties/sold/count-by-zip/","method":"GET","description":"\n

Get the count of sold properties in a ZIP code area. Use this before calling Sold Properties by ZIP to estimate credit cost.

\n

Credit Cost: 1 credit per request

\n "},{"id":1018,"name":"Mortgage & Lien Data","order":28,"identifier":"mortgage_lien","credits":5,"url":"https://developers.homesage.ai/api/mortgage-lien/analysis/","method":"GET","description":"\n

Retrieve comprehensive mortgage and lien data for any US residential property. Returns current and historical mortgages, lien summary with equity estimates, involuntary liens, and pre-foreclosure status.

\n

Authentication: Bearer token required.

\n

Credit Cost: 5 credits per fresh request. Cached responses (within 7 days) are free.

\n

What You Get:

\n \n

Caching:

\n

Results are cached for 7 days. Cached responses return instantly and do not charge credits. Only fresh lookups consume credits.

\n

Processing Time: 3-10 seconds for fresh lookups. Instant for cached results.

\n "},{"id":1033,"name":"Credit Balance","order":31,"identifier":"credit_balance","credits":0,"url":"https://developers.homesage.ai/api/usage/credits/","method":"GET","description":"\n

Retrieve your account's current API credit balance and plan/billing context.

\n

This endpoint is intended for usage monitoring — call it before a session to confirm\n you have credits available, or poll it to drive your own low-balance alerts.

\n

Authentication: API key only. Pass your key as a Bearer token in the\n Authorization header. The endpoint returns the balance for the account that\n owns the key; no email address or other identifier is needed.

\n

Cost: This call is free — it does not consume any credits.

\n "},{"id":1034,"name":"Location Red Flags","order":32,"identifier":"location_red_flags","credits":5,"url":"https://developers.homesage.ai/api/properties/red-flags/stream/","method":"POST","description":"

Analyze a property address for nearby location red flags (liquor stores, industrial sites, etc.) using nearby-places data and AI analysis of street-level imagery. Returns a risk score, a risk level, and a scored list of nearby risk factors.

Cost: 5 credits per request

"},{"id":1045,"name":"Sage Model Usage","order":37,"identifier":"sage_llm_usage","credits":0,"url":"https://api.homesage.ai/api/sage/usage/","method":"POST","description":"

Internal endpoint. The Sage assistant reports the model tokens one of its runs consumed; HomeSage prices them and debits the account the run belonged to.

Charges recorded under this endpoint are Sage's own reading, reasoning and writing — not the tools Sage ran, which are billed by their own endpoints.

Cost: the call itself is free; the credits are the metered tokens.

"},{"id":1046,"name":"Motivated Seller Score","order":38,"identifier":"motivated_seller","credits":1,"url":"https://developers.homesage.ai/api/properties/motivated-seller/","method":"GET","description":"\n

Scores how motivated a property's seller appears to be, on a 0-100 scale with a plain-language level label. Built for lead prioritisation: work the Highly Motivated list first.

\n

Authentication: Bearer token required.

\n

Credit Cost: 1 credit per request.

\n

How the score is composed:

\n \n

Listing wording can only raise a score, never lower it: a property whose remarks say nothing motivating scores exactly its price flexibility.

\n

Levels:

\n \n

Evidence returned with every score:

\n \n

Note: sold properties have no price-flexibility signal by design and return 400.

\n "},{"id":1011,"name":"Skip Tracing - Property Owner Information","order":39,"identifier":"skip_tracing_property_owner","credits":4,"url":"https://developers.homesage.ai/api/properties/skip-tracing/property-owner-information/","method":"POST","description":"\n

Retrieve comprehensive property owner contact information including names, phone numbers, email addresses, and mailing addresses. This endpoint performs skip tracing to find current property owner details for any US residential address.

\n

Authentication Required: Bearer token authentication is required.

\n

Credit Cost: 4 credits per matched address. Addresses with no owner information found are not charged.

\n

Key Features:

\n \n

Input Format Options:

\n

Three flexible formats are supported:

\n
    \n
  1. Simple Address String: {\"address\": \"123 Main St, Los Angeles, CA 90001\"}
    2. \n
  2. Batch Array: {\"addresses\": [\"address1\", \"address2\", ...]}
    3. \n
  3. Structured Format: {\"requests\": [{\"propertyAddress\": {\"street\": \"123 Main St\", \"city\": \"Los Angeles\", \"state\": \"CA\", \"zip\": \"90001\"}}]}
    4. \n
\n

Response Includes:

\n \n

Processing Time: 2-10 seconds per property depending on data availability.

\n

No Results: If no owner information is found, you will NOT be charged credits.

\n "},{"id":1012,"name":"Skip Tracing - Associated People","order":40,"identifier":"skip_tracing_associated_people","credits":1,"url":"https://developers.homesage.ai/api/properties/skip-tracing/associated-people/","method":"POST","description":"\n

Retrieve a list of people associated with a property address. This endpoint provides demographic information, residence history, and related persons for individuals linked to a specific address. Use this as a first step before getting detailed person information.

\n

Authentication Required: Bearer token authentication is required.

\n

Credit Cost: 1 credit per request (only charged if people are found).

\n

Key Features:

\n \n

Workflow:

\n

This endpoint is typically used as the first step in a two-step process:

\n
    \n
  1. Step 1: Use Associated People to get a list of people and their person_id
    2. \n
  2. Step 2: Use Person Details API with the person_id to get comprehensive contact information
    3. \n
\n

Response Includes:

\n \n

Processing Time: 1-5 seconds depending on data availability.

\n

No Results: If no associated people are found, you will NOT be charged credits.

\n "},{"id":1009,"name":"Skip Tracing - Person Details","order":41,"identifier":"skip_tracing_person_details","credits":1,"url":"https://developers.homesage.ai/api/properties/skip-tracing/person-details/","method":"POST","description":"\n

Retrieve comprehensive detailed information about a specific person using their Person ID. This endpoint provides complete contact information, address history, phone numbers, email addresses, relatives, and associates for an individual.

\n

Authentication Required: Bearer token authentication is required.

\n

Credit Cost: 1 credit per request (only charged if details are found).

\n

Key Features:

\n \n

Workflow:

\n

This endpoint is typically used as the second step in a two-step process:

\n
    \n
  1. Step 1: Use Associated People API to find people at an address and get their person_id
    2. \n
  2. Step 2: Use this Person Details API with the person_id to get full contact information
    3. \n
\n

Person ID Source:

\n

The person_id is obtained from the Associated People API. You cannot use this endpoint without first getting a valid person_id from that endpoint.

\n

Response Includes:

\n \n

Processing Time: 1-5 seconds depending on data availability.

\n

No Results: If no person details are found, you will NOT be charged credits.

\n "}]}