All of what’s possible to do with the website is also possible via a web API. This document explains how the API is organized and how you can query it.

The only supported data format is JSON.

Overall organisation

You can access three different things: projects, members and bills. You can also get the balance for a project.

The examples here are using curl, feel free to use whatever you want to do the same thing, curl is not a requirement.


To interact with bills and members, and to do something else than creating a project, you need to be authenticated. The only way to authenticate yourself currently is using the “basic” HTTP authentication.

For instance, here is how to see the what’s in a project, using curl:

$ curl --basic -u demo:demo


You can’t list projects, for security reasons. But you can create, update and delete one directly from the API.

The URLs are /api/projects and /api/projects/<identifier>.

Creating a project

A project needs the following arguments:

  • name: The project name (string)
  • id: the project identifier (string without special chars or spaces)
  • password: the project password / secret code (string)
  • contact_email: the contact email
$ curl -X POST \
-d 'name=yay&id=yay&password=yay&'

As you can see, the API returns the identifier of the project

Getting information about the project

Getting information about the project:

$ curl --basic -u demo:demo
    "name": "demonstration",
    "contact_email": "",
    "password": "demo",
    "id": "demo",
    "active_members": [{"activated": true, "weight": 1, "id": 31, "name": "Arnaud"},
                        {"activated": true, "weight": 1, "id": 32, "name": "Alexis"},
                        {"activated": true, "weight": 1, "id": 33, "name": "Olivier"},
                        {"activated": true, "weight": 1, "id": 34, "name": "Fred"}],
    "members": [{"activated": true, "weight": 1, "id": 31, "name": "Arnaud"},
                {"activated": true, "weight": 1, "id": 32, "name": "Alexis"},
                {"activated": true, "weight": 1, "id": 33, "name": "Olivier"},
                {"activated": true, "weight": 1, "id": 34, "name": "Fred"}],
    "balance": {
        "31": 6.0,
        "32": 6.0
        "33": -6.0
        "34": -6.0

Updating a project

Updating a project is done with the PUT verb:

$ curl --basic -u yay:yay -X PUT\ -d\

Deleting a project

Just send a DELETE request ont the project URI

$ curl --basic -u demo:demo -X DELETE


You can get all the members with a GET on /api/projects/<id>/members:

$ curl --basic -u demo:demo\
[{"weight": 1, "activated": true, "id": 31, "name": "Arnaud"},
 {"weight": 1, "activated": true, "id": 32, "name": "Alexis"},
 {"weight": 1, "activated": true, "id": 33, "name": "Olivier"},
 {"weight": 1, "activated": true, "id": 34, "name": "Fred"}]

Add a member with a POST request on /api/projects/<id>/members:

$ curl --basic -u demo:demo -X POST\ -d 'name=tatayoyo'

You can also PUT a new version of a member (changing its name):

$ curl --basic -u demo:demo -X PUT\\
-d 'name=yeaaaaah'
{"activated": true, "id": 36, "name": "yeaaaaah", "weight": 1}

Delete a member with a DELETE request on /api/projects/<id>/members/<member-id>:

$ curl --basic -u demo:demo -X DELETE\


You can get the list of bills by doing a GET on /api/projects/<id>/bills

$ curl --basic -u demo:demo

Add a bill with a POST query on /api/projects/<id>/bills. you need the following params:

  • date: the date of the bill; defaults to current date if not provided. (format is yyyy-mm-dd)
  • what: what have been payed
  • payer: by who ? (id)
  • payed_for: for who ? (id, to set multiple id use a list, e.g. ["id1", "id2"])
  • amount: amount payed

Returns the id of the created bill

$ curl --basic -u demo:demo -X POST\\
-d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=200"

You can also PUT a new version of the bill at /api/projects/<id>/bills/<bill-id>:

$ curl --basic -u demo:demo -X PUT\\
-d "date=2011-09-10&what=raclette&payer=31&payed_for=31&amount=250"

And you can of course DELETE them at /api/projects/<id>/bills/<bill-id>:

$ curl --basic -u demo:demo -X DELETE\\


You can get some project stats with a GET on /api/projects/<id>/statistics:

$ curl --basic -u demo:demo
        "balance": 12.5,
        "member": {"activated": True, "id": 1, "name": "alexis", "weight": 1.0},
        "paid": 25.0,
        "spent": 12.5
        "balance": -12.5,
        "member": {"activated": True, "id": 2, "name": "fred", "weight": 1.0},
        "paid": 0,
        "spent": 12.5