The API
Reading your own data out of Villagely programmatically.
Villagely has a read-only API at api.villagely.io/v1 covering seven resources — properties, units, residents, leases, ledger entries, work orders and vendors.
Keys
- Created from your account settings, and shown once. Villagely stores a hash rather than the key — if you lose it, create another.
- A short prefix is kept so you can tell which key is which without seeing it.
- Rate limits apply per key rather than per address, so one integration cannot exhaust another's budget.
- Every request is scoped to the organisation the key belongs to.
Read-only, deliberately
There is no write API today. An integration that can create a ledger entry can create a wrong one at scale, and that is not a thing to make available before somebody asks for it with a specific case.