{"$id":"https://api.stooprent.com/v1/partner-feed/schema.json","title":"Stoop partner feed, version 1","$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"format":{"type":"string","const":"stoop.partner-feed"},"version":{"type":"number","const":1},"generatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","description":"When you built this feed."},"properties":{"maxItems":5000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^\\S(?:[^\\p{Cc}]*\\S)?$","description":"Your own stable ID. Never reuse one for something else."},"name":{"type":"string","maxLength":120},"type":{"type":"string","enum":["apartment","townhome","house","room"],"description":"Duplexes, triplexes and condos are apartment."},"address":{"type":"object","properties":{"line1":{"type":"string","maxLength":200,"pattern":"\\S","description":"Street address without the unit: \"1400 Example St\"."},"city":{"type":"string","maxLength":100,"pattern":"\\S"},"state":{"type":"string","pattern":"^[A-Z]{2}$"},"postalCode":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$"}},"required":["line1","city","state","postalCode"],"additionalProperties":false,"description":"Where the building is. Stoop finds it on the map itself."},"description":{"type":"string","maxLength":10000},"amenities":{"maxItems":17,"type":"array","items":{"type":"string","enum":["in_unit_laundry","shared_laundry","dishwasher","air_conditioning","parking","ev_charging","elevator","step_free_access","gym","bike_storage","storage","balcony","yard","roof_deck","pool","concierge","furnished"]}},"photos":{"maxItems":60,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"pattern":"^https:\\/\\/[^\\s/?#]+\\.[^\\s/?#]+[^\\s]*$","description":"A JPEG, PNG or WebP image, at most 15 MB. Stoop copies it under your agreement."},"caption":{"type":"string","maxLength":200},"representative":{"description":"True when the photo shows a similar unit rather than this one. Stoop labels it.","type":"boolean"}},"required":["url"],"additionalProperties":false}},"pets":{"type":"object","properties":{"policy":{"type":"string","enum":["none","cats","dogs","cats_and_dogs","case_by_case"]},"maxPets":{"type":"integer","minimum":1,"maximum":10},"dogWeightLimitLbs":{"type":"integer","minimum":1,"maximum":300},"depositCents":{"description":"Refundable deposit per pet. Pet rent and pet fees go in fees.","type":"integer","minimum":0,"maximum":1000000}},"required":["policy"],"additionalProperties":false,"description":"Assistance animals are not pets: no pet rule, fee or deposit applies to them."},"fees":{"maxItems":40,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^\\S(?:[^\\p{Cc}]*\\S)?$","description":"Your own stable ID. Never reuse one for something else."},"label":{"type":"string","maxLength":100,"pattern":"\\S","description":"Shown to renters: \"Water, sewer and garbage\"."},"category":{"type":"string","enum":["utilities","pet","parking","insurance","admin","amenity","technology","other"]},"frequency":{"type":"string","enum":["monthly","one_time"]},"amountCents":{"description":"A fixed amount. Send this or percentOfRent.","type":"integer","minimum":0,"maximum":1000000},"percentOfRent":{"description":"A share of the rent, up to two decimals: 2 is 2%. Send this or amountCents.","type":"number","exclusiveMinimum":0,"maximum":100},"per":{"description":"What the amount is multiplied by. Leave out for once per unit.","type":"string","enum":["unit","occupant","pet"]},"required":{"type":"boolean","description":"False only for fees a renter can choose, like a parking spot or storage."},"onlyWith":{"description":"Charged only to households with these animals.","type":"string","enum":["pet","cat","dog"]},"covers":{"description":"For utility fees: which utilities it pays for, so Stoop doesn’t estimate them again.","minItems":1,"maxItems":8,"type":"array","items":{"type":"string","enum":["electricity","gas","propane","oil","water","sewer","trash","internet"]}},"waivedWith":{"description":"What a renter can show instead of paying it.","type":"string","enum":["own_renters_insurance"]}},"required":["id","label","category","frequency","required"],"additionalProperties":false},"description":"Every fee a renter here can be charged. An empty list says there are none."},"utilities":{"type":"object","properties":{"included":{"maxItems":8,"type":"array","items":{"type":"string","enum":["electricity","gas","propane","oil","water","sewer","trash","internet"]},"description":"Utilities the rent includes. Utilities you bill back are fees with covers, not included."},"heating":{"description":"electric is baseboard or furnace; heat_pump is a heat pump.","type":"string","enum":["electric","heat_pump","gas","propane","oil"]},"waterHeating":{"type":"string","enum":["electric","gas","propane","oil"]},"cooking":{"type":"string","enum":["electric","gas","propane"]},"estimateCents":{"description":"Your own monthly estimate of what renters pay utility companies directly. Beats Stoop’s estimate.","type":"integer","minimum":0,"maximum":500000}},"required":["included"],"additionalProperties":false,"description":"Stoop estimates what renters pay utility companies from these and a published utility allowance schedule."},"units":{"maxItems":5000,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^\\S(?:[^\\p{Cc}]*\\S)?$","description":"Your ID for the unit, unique across the whole feed and the same every time."},"label":{"type":"string","maxLength":40,"description":"The unit number as renters see it: \"204\". Empty for a whole house."},"type":{"description":"Leave out to use the property’s type.","type":"string","enum":["apartment","townhome","house","room"]},"floor":{"description":"1 is the ground floor.","type":"integer","minimum":-3,"maximum":200},"status":{"description":"Leave out for available. on_hold takes it out of renters’ decks now; leased ends it.","type":"string","enum":["available","on_hold","leased"]},"bedrooms":{"type":"integer","minimum":0,"maximum":12,"description":"0 for a studio."},"bathrooms":{"type":"number","minimum":0,"maximum":12},"squareFeet":{"type":"integer","minimum":100,"maximum":20000},"rentCents":{"type":"integer","minimum":10000,"maximum":10000000,"description":"Monthly rent in cents: 165000 is $1,650."},"depositCents":{"type":"integer","minimum":0,"maximum":10000000},"availableOn":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"First move-in date. Today or earlier means available now."},"minLeaseMonths":{"type":"integer","minimum":1,"maximum":36},"pets":{"description":"Leave out to use the property’s pet policy.","type":"object","properties":{"policy":{"type":"string","enum":["none","cats","dogs","cats_and_dogs","case_by_case"]},"maxPets":{"type":"integer","minimum":1,"maximum":10},"dogWeightLimitLbs":{"type":"integer","minimum":1,"maximum":300},"depositCents":{"description":"Refundable deposit per pet. Pet rent and pet fees go in fees.","type":"integer","minimum":0,"maximum":1000000}},"required":["policy"],"additionalProperties":false},"description":{"type":"string","maxLength":10000},"amenities":{"description":"Added to the property’s.","maxItems":17,"type":"array","items":{"type":"string","enum":["in_unit_laundry","shared_laundry","dishwasher","air_conditioning","parking","ev_charging","elevator","step_free_access","gym","bike_storage","storage","balcony","yard","roof_deck","pool","concierge","furnished"]}},"photos":{"description":"Best first. Shown before the property’s photos.","maxItems":60,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"pattern":"^https:\\/\\/[^\\s/?#]+\\.[^\\s/?#]+[^\\s]*$","description":"A JPEG, PNG or WebP image, at most 15 MB. Stoop copies it under your agreement."},"caption":{"type":"string","maxLength":200},"representative":{"description":"True when the photo shows a similar unit rather than this one. Stoop labels it.","type":"boolean"}},"required":["url"],"additionalProperties":false}},"fees":{"description":"Added to the property’s; one with the same id replaces it.","maxItems":40,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^\\S(?:[^\\p{Cc}]*\\S)?$","description":"Your own stable ID. Never reuse one for something else."},"label":{"type":"string","maxLength":100,"pattern":"\\S","description":"Shown to renters: \"Water, sewer and garbage\"."},"category":{"type":"string","enum":["utilities","pet","parking","insurance","admin","amenity","technology","other"]},"frequency":{"type":"string","enum":["monthly","one_time"]},"amountCents":{"description":"A fixed amount. Send this or percentOfRent.","type":"integer","minimum":0,"maximum":1000000},"percentOfRent":{"description":"A share of the rent, up to two decimals: 2 is 2%. Send this or amountCents.","type":"number","exclusiveMinimum":0,"maximum":100},"per":{"description":"What the amount is multiplied by. Leave out for once per unit.","type":"string","enum":["unit","occupant","pet"]},"required":{"type":"boolean","description":"False only for fees a renter can choose, like a parking spot or storage."},"onlyWith":{"description":"Charged only to households with these animals.","type":"string","enum":["pet","cat","dog"]},"covers":{"description":"For utility fees: which utilities it pays for, so Stoop doesn’t estimate them again.","minItems":1,"maxItems":8,"type":"array","items":{"type":"string","enum":["electricity","gas","propane","oil","water","sewer","trash","internet"]}},"waivedWith":{"description":"What a renter can show instead of paying it.","type":"string","enum":["own_renters_insurance"]}},"required":["id","label","category","frequency","required"],"additionalProperties":false}},"utilities":{"description":"Leave out to use the property’s.","type":"object","properties":{"included":{"maxItems":8,"type":"array","items":{"type":"string","enum":["electricity","gas","propane","oil","water","sewer","trash","internet"]},"description":"Utilities the rent includes. Utilities you bill back are fees with covers, not included."},"heating":{"description":"electric is baseboard or furnace; heat_pump is a heat pump.","type":"string","enum":["electric","heat_pump","gas","propane","oil"]},"waterHeating":{"type":"string","enum":["electric","gas","propane","oil"]},"cooking":{"type":"string","enum":["electric","gas","propane"]},"estimateCents":{"description":"Your own monthly estimate of what renters pay utility companies directly. Beats Stoop’s estimate.","type":"integer","minimum":0,"maximum":500000}},"required":["included"],"additionalProperties":false},"url":{"description":"The unit’s page on your website, for your leasing team.","type":"string","maxLength":2000,"pattern":"^https:\\/\\/[^\\s/?#]+\\.[^\\s/?#]+[^\\s]*$"}},"required":["id","label","bedrooms","bathrooms","rentCents","availableOn"],"additionalProperties":false}}},"required":["id","type","address","fees","utilities","units"],"additionalProperties":false},"description":"Every unit you offer on Stoop, every time. A unit left out ends after a day."}},"required":["format","version","generatedAt","properties"],"additionalProperties":false,"description":"The Stoop partner feed, version 1: every unit a property manager offers on Stoop."}