This repo powers the official documentation for the Splitwise API. You can view our official API documentation website at http://dev.splitwise.com.

If something in the API is confusing you, you can open an issue about it on GitHub. We're a small team, so we may not have an instant fix, but we'll get back to you as soon as we're able.

If you spot an issue in our API documentation itself, feel free to open a pull request to update this repo!

These API docs follow the OpenAPI v3 specification. The website is built with redoc.

$ npm install
$ npm run serve

This will start a local HTTP server that serves the documentation and rebuilds whenever any of the OpenAPI source files are modified.

This will create a zero-dependency HTML file at docs/index.html.

$ npm run build