https://github.com/splitwise/api-docs

API documentation for the Splitwise API.
https://github.com/splitwise/api-docs

Last synced: about 1 month ago
JSON representation

API documentation for the Splitwise API.

• Host: GitHub
• URL: https://github.com/splitwise/api-docs
• Owner: splitwise
• Created: 2017-07-24T15:31:21.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T14:00:08.000Z (9 months ago)
• Last Synced: 2024-04-09T18:02:33.687Z (9 months ago)
• Homepage: http://dev.splitwise.com
• Size: 2.88 MB
• Stars: 25
• Watchers: 12
• Forks: 16
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Welcome to the Splitwise API!

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

## Questions? Issues?

If something in the API is confusing you, you can open an [issue](https://github.com/splitwise/api-docs/issues) 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](https://github.com/splitwise/api-docs/pulls) to update this repo!

## Powered by OpenAPI + redocly

These API docs follow the [OpenAPI v3](https://swagger.io/specification/) specification. The website is built with [redoc](https://github.com/Redocly/redoc).

### Developing

```

$ 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.

### Compiling

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

```

$ npm run build

```