API Documentation



worlds

The ZimpleMoney system supports multiple "worlds". Worlds are identified in the online system by the host name, as <world>.zimplemoney.com. There is a default world at zimplemoney.com.

Users (members) are global access all worlds. However contracts (loans) are specific to a particular world.

The ZimpleMoney API enables identification of worlds in the request path, like this:

api.zimplemoney.com/<world>/<endpoint>

If no world is specified in the request path, then the default world will be accessed, like this:

api.zimplemoney.com/<endpoint>

The entire functionality of the API is the same regardless of world, but depending on the world specified in the request path, different information will be accessed. For example, the /contracts endpoint will only return contracts in the world specified on the request.


The remainder of this documentation discusses the endpoints and their parameters generically, without regard to worlds.


Next: Authentication

© 2025 Zimple Money