habitaclia agency
A habitaclia agency: business details (name, legal name, logo, website, phone, e-mail, address, coordinates, description, registrations, languages, services, social links, minisite) with its listing counts, and its listings with the search's transaction, property type and sort. Pass next_page back as page; null on the last page.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
idrequired | string | Agency id (agency.id of a listing). Example: 243d7b0b-7f90-459c-bbc2-dc7e55a9eefa |
transaction | buy | rent | transfer | new_homes | Transaction of the listings. Example: buy |
property_type | homes | offices | premises | industrial | land | garages | buildings | Property type of the listings. Example: homes |
sort | relevance | newest | price_asc | price_desc | largest | smallest | price_m2_asc | price_drop | Sort order. |
limit | integer | Listings per page (1-100, default 30). |
page | integer | Results page (1 = first). Pass next_page back here. |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/habitaclia/v1/agency?id=243d7b0b-7f90-459c-bbc2-dc7e55a9eefa" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/habitaclia/v1/agency",
params={"id": "243d7b0b-7f90-459c-bbc2-dc7e55a9eefa"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/habitaclia/v1/agency");
url.searchParams.set("id", "243d7b0b-7f90-459c-bbc2-dc7e55a9eefa");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).