RentalHunter

Checks that the RentalHunter connector can reach its inventory. Returns ok, the public hunt URL, and the privacy, terms, and support links.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lists cities on RentalHunter, each city's budget currency, stay lengths, and the live USD rates.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Searches RentalHunter inventory by city, locality, stay length, budget, and must-haves the seeker named. Set furnished true only when the seeker explicitly asks for furnished. Omit it for any furnishing. Locality is exact: Baner does not include Hinjewadi. Returns matching homes with local-currency rent, stay fit, furnishing (furnished, semi-furnished, unfurnished, or not specified), deposit, lock-in, verification, freshness, and a listing link. An empty result means nothing matched. The summary mentions furnished only when that filter was applied. Does not return image bytes.

{
  "type": "object",
  "properties": {
    "city": {
      "type": "string",
      "enum": [
        "pune",
        "ho-chi-minh",
        "bangkok",
        "hanoi",
        "da-nang",
        "phuket",
        "dubai",
        "sharjah"
      ],
      "description": "City slug"
    },
    "stay_nights": {
      "anyOf": [
        {
          "type": "number",
          "const": 7
        },
        {
          "type": "number",
          "const": 14
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 60
        },
        {
          "type": "number",
          "const": 90
        },
        {
          "type": "number",
          "const": 180
        },
        {
          "type": "number",
          "const": 330
        },
        {
          "type": "number",
          "const": 365
        }
      ],
      "description": "Desired stay length in nights (7=1 week … 330=11 months, 365=12 months). 11 months is offered everywhere; it is the standard residential lease in India."
    },
    "price_max": {
      "description": "Max monthly rent in `currency` units. Defaults to the city's local currency (Pune INR, Dubai/Sharjah AED, Bangkok/Phuket THB, Vietnam VND). Example: 30000 INR, 4000 AED.",
      "type": "number",
      "minimum": 100,
      "maximum": 500000000
    },
    "currency": {
      "description": "Budget currency for price_max. Defaults to the city's local currency. USD rates are the live cached interbank quote. Saved alerts store the USD equivalent.",
      "type": "string",
      "enum": [
        "INR",
        "USD",
        "EUR",
        "GBP",
        "AED",
        "THB",
        "VND"
      ]
    },
    "bedrooms_min": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "furnished": {
      "description": "Set true only when the seeker explicitly asks for furnished. Omit for any furnishing.",
      "type": "boolean"
    },
    "pet_friendly": {
      "description": "True only when pets are required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "near_transit": {
      "description": "True only when near transit is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "near_coworking": {
      "description": "True only when near coworking is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "available_by": {
      "description": "Move-in by date, YYYY-MM-DD",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "locality": {
      "description": "Exact area inside the city, such as Baner or Kharadi. A Baner search does not return Hinjewadi.",
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "lock_in_max": {
      "description": "Max lock-in months the seeker will accept",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "deposit_months_max": {
      "description": "Max security deposit in months of rent",
      "type": "number",
      "minimum": 0,
      "maximum": 12
    },
    "attached_bath": {
      "description": "True only when an attached bath is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "has_ac": {
      "description": "True only when AC is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "no_curfew": {
      "description": "True when the seeker needs no gate curfew. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "has_lift": {
      "description": "True only when a lift or elevator is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "area_min": {
      "description": "Optional minimum apartment size. Pair with area_unit. Omit for any size.",
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "area_unit": {
      "description": "Unit for area_min. Use sqft in Pune and sqm in other cities. Defaults from the city when area_min is set and this is omitted.",
      "type": "string",
      "enum": [
        "sqft",
        "sqm"
      ]
    },
    "status": {
      "description": "Household: Single, Couple, or Family (values single, partner, or family). single matches Everyone and Singles only. partner is Couple and matches Everyone and Couples. family matches Everyone and Families only.",
      "type": "string",
      "enum": [
        "single",
        "partner",
        "family"
      ]
    },
    "has_pets": {
      "description": "True when the seeker has pets. Excludes homes that explicitly disallow pets. Unknown pet policy still appears as ask about pets.",
      "type": "boolean"
    }
  },
  "required": [
    "city"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns one RentalHunter listing by id: local-currency rent, locality, stay fit, furnishing (furnished, semi-furnished, unfurnished, or not specified), deposit, lock-in, verification badges, freshness, and the listing link. A missing or unavailable id returns found false and does not substitute another home.

{
  "type": "object",
  "properties": {
    "listing_id": {
      "type": "string",
      "minLength": 4,
      "maxLength": 64,
      "pattern": "^[A-Za-z0-9_-]+$",
      "description": "Listing id from search_rentals"
    },
    "stay_nights": {
      "description": "Seeker stay length, used only to say whether this home fits",
      "anyOf": [
        {
          "type": "number",
          "const": 7
        },
        {
          "type": "number",
          "const": 14
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 60
        },
        {
          "type": "number",
          "const": 90
        },
        {
          "type": "number",
          "const": 180
        },
        {
          "type": "number",
          "const": 330
        },
        {
          "type": "number",
          "const": 365
        }
      ]
    }
  },
  "required": [
    "listing_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Saves a hunt alert for this query after the seeker agrees to share their email with partners whose listings match, and emails them when a home matches. Requires consent true. Does not accept a phone number. A phone is shared later only on the website, and only with the partner whose property the seeker shortlists. Creates a seeker account when the email is new. An email that already has an account is not attached from this tool; the hunt stays pending until that person confirms it. Verify your phone so matching partners can reach you.

{
  "type": "object",
  "properties": {
    "consent": {
      "type": "boolean",
      "description": "True only when the seeker has explicitly agreed, for this query, to share this email with partners whose listings match. This is not consent to share a phone number."
    },
    "email": {
      "type": "string",
      "maxLength": 120,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "description": "Email the seeker agreed to share"
    },
    "name": {
      "description": "Seeker display name",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "hunt_name": {
      "description": "Optional label for the saved hunt",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "city": {
      "type": "string",
      "enum": [
        "pune",
        "ho-chi-minh",
        "bangkok",
        "hanoi",
        "da-nang",
        "phuket",
        "dubai",
        "sharjah"
      ],
      "description": "City slug"
    },
    "stay_nights": {
      "anyOf": [
        {
          "type": "number",
          "const": 7
        },
        {
          "type": "number",
          "const": 14
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 60
        },
        {
          "type": "number",
          "const": 90
        },
        {
          "type": "number",
          "const": 180
        },
        {
          "type": "number",
          "const": 330
        },
        {
          "type": "number",
          "const": 365
        }
      ],
      "description": "Desired stay length in nights (7=1 week … 330=11 months, 365=12 months). 11 months is offered everywhere; it is the standard residential lease in India."
    },
    "price_max": {
      "description": "Max monthly rent in `currency` units. Defaults to the city's local currency (Pune INR, Dubai/Sharjah AED, Bangkok/Phuket THB, Vietnam VND). Example: 30000 INR, 4000 AED.",
      "type": "number",
      "minimum": 100,
      "maximum": 500000000
    },
    "currency": {
      "description": "Budget currency for price_max. Defaults to the city's local currency. USD rates are the live cached interbank quote. Saved alerts store the USD equivalent.",
      "type": "string",
      "enum": [
        "INR",
        "USD",
        "EUR",
        "GBP",
        "AED",
        "THB",
        "VND"
      ]
    },
    "bedrooms_min": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "furnished": {
      "description": "Set true only when the seeker explicitly asks for furnished. Omit for any furnishing.",
      "type": "boolean"
    },
    "pet_friendly": {
      "description": "True only when pets are required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "near_transit": {
      "description": "True only when near transit is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "near_coworking": {
      "description": "True only when near coworking is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "available_by": {
      "description": "Move-in by date, YYYY-MM-DD",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "locality": {
      "description": "Exact area inside the city, such as Baner or Kharadi. A Baner search does not return Hinjewadi.",
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "lock_in_max": {
      "description": "Max lock-in months the seeker will accept",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "deposit_months_max": {
      "description": "Max security deposit in months of rent",
      "type": "number",
      "minimum": 0,
      "maximum": 12
    },
    "attached_bath": {
      "description": "True only when an attached bath is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "has_ac": {
      "description": "True only when AC is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "no_curfew": {
      "description": "True when the seeker needs no gate curfew. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "has_lift": {
      "description": "True only when a lift or elevator is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "area_min": {
      "description": "Optional minimum apartment size. Pair with area_unit. Omit for any size.",
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "area_unit": {
      "description": "Unit for area_min. Use sqft in Pune and sqm in other cities. Defaults from the city when area_min is set and this is omitted.",
      "type": "string",
      "enum": [
        "sqft",
        "sqm"
      ]
    },
    "status": {
      "description": "Household: Single, Couple, or Family (values single, partner, or family). single matches Everyone and Singles only. partner is Couple and matches Everyone and Couples. family matches Everyone and Families only.",
      "type": "string",
      "enum": [
        "single",
        "partner",
        "family"
      ]
    },
    "has_pets": {
      "description": "True when the seeker has pets. Excludes homes that explicitly disallow pets. Unknown pet policy still appears as ask about pets.",
      "type": "boolean"
    }
  },
  "required": [
    "consent",
    "email",
    "city"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Reports which hunt fields are still missing. When city, stay length, and budget are present, searches inventory. Does not save an alert or collect an email.

{
  "type": "object",
  "properties": {
    "city": {
      "type": "string",
      "enum": [
        "pune",
        "ho-chi-minh",
        "bangkok",
        "hanoi",
        "da-nang",
        "phuket",
        "dubai",
        "sharjah"
      ],
      "description": "City slug"
    },
    "stay_nights": {
      "anyOf": [
        {
          "type": "number",
          "const": 7
        },
        {
          "type": "number",
          "const": 14
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 60
        },
        {
          "type": "number",
          "const": 90
        },
        {
          "type": "number",
          "const": 180
        },
        {
          "type": "number",
          "const": 330
        },
        {
          "type": "number",
          "const": 365
        }
      ],
      "description": "Desired stay length in nights (7=1 week … 330=11 months, 365=12 months). 11 months is offered everywhere; it is the standard residential lease in India."
    },
    "price_max": {
      "description": "Max monthly rent in `currency` units. Defaults to the city's local currency (Pune INR, Dubai/Sharjah AED, Bangkok/Phuket THB, Vietnam VND). Example: 30000 INR, 4000 AED.",
      "type": "number",
      "minimum": 100,
      "maximum": 500000000
    },
    "currency": {
      "description": "Budget currency for price_max. Defaults to the city's local currency. USD rates are the live cached interbank quote. Saved alerts store the USD equivalent.",
      "type": "string",
      "enum": [
        "INR",
        "USD",
        "EUR",
        "GBP",
        "AED",
        "THB",
        "VND"
      ]
    },
    "bedrooms_min": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5
    },
    "furnished": {
      "description": "Set true only when the seeker explicitly asks for furnished. Omit for any furnishing.",
      "type": "boolean"
    },
    "pet_friendly": {
      "description": "True only when pets are required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "near_transit": {
      "description": "True only when near transit is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "near_coworking": {
      "description": "True only when near coworking is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "available_by": {
      "description": "Move-in by date, YYYY-MM-DD",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "locality": {
      "description": "Exact area inside the city, such as Baner or Kharadi. A Baner search does not return Hinjewadi.",
      "type": "string",
      "minLength": 2,
      "maxLength": 80
    },
    "lock_in_max": {
      "description": "Max lock-in months the seeker will accept",
      "type": "integer",
      "minimum": 0,
      "maximum": 24
    },
    "deposit_months_max": {
      "description": "Max security deposit in months of rent",
      "type": "number",
      "minimum": 0,
      "maximum": 12
    },
    "attached_bath": {
      "description": "True only when an attached bath is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "has_ac": {
      "description": "True only when AC is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "no_curfew": {
      "description": "True when the seeker needs no gate curfew. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "status": {
      "description": "Household: Single, Couple, or Family (values single, partner, or family). single matches Everyone and Singles only. partner is Couple and matches Everyone and Couples. family matches Everyone and Families only.",
      "type": "string",
      "enum": [
        "single",
        "partner",
        "family"
      ]
    },
    "has_pets": {
      "description": "True when the seeker has pets. Excludes homes that explicitly disallow pets. Unknown pet policy still appears as ask about pets.",
      "type": "boolean"
    },
    "has_lift": {
      "description": "True only when a lift or elevator is required. Omit or false means not required, not excluded.",
      "type": "boolean"
    },
    "area_min": {
      "description": "Optional minimum apartment size. Pair with area_unit. Omit for any size.",
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "area_unit": {
      "description": "Unit for area_min. Use sqft in Pune and sqm in other cities. Defaults from the city when area_min is set and this is omitted.",
      "type": "string",
      "enum": [
        "sqft",
        "sqm"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lists this partner's own homes with status, a verified flag, and counts of views, saves, matched hunts, and accepted hunts for the last 7 and 30 days. Requires a partner API token. Other partners' homes are never included.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns status, the verified flag, and 7- and 30-day counts for one home this partner owns. A home owned by someone else is reported as not in your inventory.

{
  "type": "object",
  "properties": {
    "listing_id": {
      "type": "string",
      "minLength": 4,
      "maxLength": 64,
      "pattern": "^[A-Za-z0-9_-]+$",
      "description": "Id of one of this partner's homes"
    }
  },
  "required": [
    "listing_id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lists recent hunts that match this partner's homes. Seeker name and email stay hidden until this partner has already accepted that hunt. Phone numbers are never included.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Suggests improvements for this partner's homes, such as a home with no photos or rent far above the local median for the same city and bedrooms.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}