Read homes from your own code.

What HabitatSignal reads, a home from its photographs, what sits right outside it and the neighbourhood around it, is open to your code through the API and to ChatGPT or Claude through our MCP server. The same reads and the same credits, on one Sirente account. Make a key in the console and start your first read.

Two ways in

Your code

Make a key in the console and send it as a bearer token to

https://api.sirente.ai

Open the console

Your assistant

Add our MCP server as a connector in ChatGPT or Claude, then sign in with your account and allow it.

https://mcp.sirente.ai/habitatsignal

One request, one verdict

Start a read with the photos and, if you have it, the home's Maps link. The read runs on its own; check back after the seconds it names. The same retry key never starts a second read or charges twice.

Start a read
curl https://api.sirente.ai/api/v1/reads/home \
  -H "Authorization: Bearer $SIRENTE_KEY" \
  -H "Idempotency-Key: 4f1c9a2e-first-read" \
  -H "Content-Type: application/json" \
  -d '{
    "images": ["data:image/jpeg;base64,/9j/4AAQ..."],
    "propertyData": { "mapsUrl": "https://maps.app.goo.gl/..." }
  }'
It answers at once
202 Accepted
{ "data": { "readId": "rd_8Qm2vT0kLr5wXb7nHc3pZs1e",
            "status": "running", "checkAfter": 15,
            "statusUrl": "/api/v1/reads/rd_8Qm2vT0kLr5wXb7nHc3pZs1e" } }
Then, when it is done
GET /api/v1/reads/rd_8Qm2vT0kLr5wXb7nHc3pZs1e
{ "data": { "status": "done",
            "result": { "score": 7.9, "triage": "worth-visiting",
                        "verdictReason": { ... }, "surroundings": { ... } } } }
A real read

The card HabitatSignal shows for a read. Your code gets the same read as data.

What you can call

Every route below, with what it costs. Assistants get the same 25, and 3 more that combine them.

Homes

Read a home from its photosPOST /api/v1/reads/home
1 credit a home (2 with a video walkthrough); nothing if the read fails
Check a home readGET /api/v1/reads/{readId}
Free
Read many homes at oncePOST /api/v1/analyze_batch
1 credit a home, charged as each read is stored
Check a batch of readsGET /api/v1/analyze_batch/{batchId}
Free
Stop a batch of readsDELETE /api/v1/analyze_batch/{batchId}
Free

Locations

Read the surroundings of a Maps linkPOST /api/v1/locate
Half a credit, once per person and location
Read what is right outside a locationPOST /api/v1/surroundings/read
Half a credit, once per person and location
Add a Maps link to a home already readPUT /api/v1/analyses/{homeNumber}/location
Free for the first location; then half a credit per change, once per person and location

Areas

Read an areaGET /api/v1/locality_brief
A quarter credit, once per person and area
Compare areasGET /api/v1/localities/compare
A quarter credit for the comparison, once per person and set
Best areas in a cityGET /api/v1/localities/top
A quarter credit, once per person and city
Places to know in an areaGET /api/v1/localities/highlights
A quarter credit, once per person, area and kind

Your homes and plans

List my homesGET /api/v1/analyses
Free
Find my homes by listing factsGET /api/v1/analyses/filter
Free
Open a home's full readGET /api/v1/analyses/{homeNumber}
Free
Rank homes for visitsPOST /api/v1/rank_shortlist
Free
Decide on one homePOST /api/v1/recommend_next_action
Free
Love a homePOST /api/v1/shortlist
Free
List my Loved homesGET /api/v1/shortlist
Free
Unlove a homeDELETE /api/v1/shortlist/{homeNumber}
Free
Plan a visitPOST /api/v1/visits
Free
Record how a visit wentPOST /api/v1/visits/outcome
Free
My prioritiesGET /api/v1/preferences
Free
Set my prioritiesPUT /api/v1/preferences
Free
My balanceGET /api/v1/credits
Free

Prices

A home read
1 credit
A home read with a video walkthrough
2 credits
A location on its own
Half a credit
An area on its own
A quarter credit

Credits come in packs, bought on HabitatSignal and shared by every way in.

Peek · 2 credits, 30 days
₹229
₹199 as your first pack
Hunt · 10 credits, 60 days
₹999
₹899 as your first pack
Serious Hunt · 25 credits, 90 days
₹2,399
₹2,149 as your first pack
Power Pack · 50 credits, 90 days
₹4,499
₹3,999 as your first pack
Buy credits

The rules

Your key
One key per account, shown once when you make it. Keep it on your server, never in a web page or an app people download. Making one asks for a verified phone number and a sign-in in the last 15 minutes. Revoke it in the console at any time: anything using it stops at once.
Charges
A read that fails is never charged. A location or an area is charged once for each person, however often it is read again. Your balance is one call away.
Retries
Send an Idempotency-Key with a read or a batch. The same key returns the same read, so a retry after a dropped connection is always safe.
Versions
Every answer names the contract it follows in X-Contract-Version, now 2.0.0.

When something goes wrong

401 invalid_api_key
The key is wrong, revoked or expired. Check it, or make a new one in the console.
402 insufficient_credits
The account has no credits for this. Buy credits on HabitatSignal, then send it again.
404 read_not_found
No read with that id belongs to this account. Use the readId from the start answer.
429
Too many requests at once, or too many reads running on the account. Wait the seconds in Retry-After, then send it again.
status "failed"
The read could not be finished and nothing was charged. Its error says why, for example photos_unreadable when the photos could not be opened as images.

For machines