Download OpenAPI specification:Download
Hey there! We're glad you're interested in the Splitwise API. This documentation will help you to fetch information on users, expenses, groups, and much more.
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 website!)
The development community has built a number of unofficial, third-party SDKs for Splitwise in a variety of different languages.
If you've built a third-party SDK for Splitwise and you'd like to see it included in this list, then please open a pull request to update this section and add a new link. Thank you for your work!
Note: These links are provided for convenience. These libraries have not been reviewed or endorsed by Splitwise, and Splitwise cannot vouch for their quality. If you have questions or bug reports, please direct your feedback to the authors of these libraries.
Splitwise provides this Self-Serve API to facilitate integrations with third-party applications, as well as open-up functionality for hobbyists and power users to programmatically interact with their own Splitwise account and build plugins or other tools.
If you’re interested in integrating your commercial application with Splitwise, we strongly encourage you to contact developers@splitwise.com so our development team can help discuss your use case, provide private APIs and Enterprise support, and offer an appropriate commercial license for the integration. The Self-Serve API documented here may be suitable for internal prototyping and other exploratory work.
If you are developing a non-commercial plugin application or personal project, we recommend you make use of the Self-Serve API documented here under the API Terms Of Use. Please be aware that our Self-Serve API has conservative rate and access limits, which are subject to change at any time and not well suited to commercial projects. If this is a problem for your use case, please contact us at developers@splitwise.com to discuss your needs.
All Self-Service API users are subject to the API Terms of Use below.
These API Terms of Use describe your rights and responsibilities when accessing our publicly available Application Programming Interface (API) and related API documentation. Please review them carefully.
Splitwise may modify this Agreement at any time by posting a revised version on our website. The revised version will be effective at the time that it is posted.
These API terms form a binding contract between you and us. In these terms "you," and "your," refers to the individual, company or legal entity and/or entities that you represent while accessing the API. “We”, “us”, “our” and “Splitwise” refers to Splitwise Inc. By accepting these API terms, either by accessing or using the API, or authorizing or permitting any individual to access or use the API, you agree to be bound by this contract.
Splitwise uses OAuth 2 with the authorization code flow. To connect via OAuth 2, you'll need to register your app. When you register, you'll be given a key and secret.
Note: OAuth can be a very confusing protocol to implement correctly, and we strongly recommend that you use an existing OAuth library to connect to Splitwise. You can find a list of OAuth client libraries at the OAuth community site.
For more information on using OAuth, check out the following resources:
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: /oauth/authorize Token URL: /oauth/token Scopes: |
For speed and ease of prototyping, you can generate a personal API key on your app's details page. You should present this key to the server via the Authorization header as a Bearer token. The API key is an access token for your personal account, so keep it as safe as you would a password. If your key becomes compromised or you want to invalidate your existing key for any other reason, you can do so on the app details page by generating a new key.
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
Bearer format | "API key" |
{- "user": {
- "id": 0,
- "first_name": "Ada",
- "last_name": "Lovelace",
- "email": "ada@example.com",
- "registration_status": "confirmed",
- "picture": {
- "small": "string",
- "medium": "string",
- "large": "string"
}, - "custom_picture": false,
- "notifications_read": "2017-06-02T20:21:57Z",
- "notifications_count": 12,
- "notifications": {
- "added_as_friend": true
}, - "default_currency": "USD",
- "locale": "en"
}
}
{- "user": {
- "id": 0,
- "first_name": "Ada",
- "last_name": "Lovelace",
- "email": "ada@example.com",
- "registration_status": "confirmed",
- "picture": {
- "small": "string",
- "medium": "string",
- "large": "string"
}, - "custom_picture": false
}
}
id required | integer |
first_name | string |
last_name | string |
string | |
password | string |
locale | string |
default_currency | string |
{- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "password": "string",
- "locale": "string",
- "default_currency": "string"
}
{- "id": 0,
- "first_name": "Ada",
- "last_name": "Lovelace",
- "email": "ada@example.com",
- "registration_status": "confirmed",
- "picture": {
- "small": "string",
- "medium": "string",
- "large": "string"
}, - "custom_picture": false
}
A Group represents a collection of users who share expenses together. For example, some users use a Group to aggregate expenses related to a home. Others use it to represent a trip. Expenses assigned to a group are split among the users of that group. Importantly, two users in a Group can also have expenses with one another outside of the Group.
Note: Expenses that are not associated with a group are listed in a group with ID 0.
{- "groups": [
- {
- "id": 321,
- "name": "Housemates 2020",
- "group_type": "home",
- "updated_at": "2019-08-24T14:15:22Z",
- "simplify_by_default": true,
- "members": [
- {
- "id": 0,
- "first_name": "Ada",
- "last_name": "Lovelace",
- "email": "ada@example.com",
- "registration_status": "confirmed",
- "picture": {
- "small": "string",
- "medium": "string",
- "large": "string"
}, - "custom_picture": false,
- "balance": [
- {
- "currency_code": "USD",
- "amount": "-5.02"
}
]
}
], - "original_debts": [
- {
- "from": 18523,
- "to": 90261,
- "amount": "414.5",
- "currency_code": "USD"
}
], - "simplified_debts": [
- {
- "from": 18523,
- "to": 90261,
- "amount": "414.5",
- "currency_code": "USD"
}
], - "avatar": {
- "original": null,
}, - "custom_avatar": true,
}
]
}
{- "group": {
- "id": 321,
- "name": "Housemates 2020",
- "group_type": "home",
- "updated_at": "2019-08-24T14:15:22Z",
- "simplify_by_default": true,
- "members": [
- {
- "id": 0,
- "first_name": "Ada",
- "last_name": "Lovelace",
- "email": "ada@example.com",
- "registration_status": "confirmed",
- "picture": {
- "small": "string",
- "medium": "string",
- "large": "string"
}, - "custom_picture": false,
- "balance": [
- {
- "currency_code": "USD",
- "amount": "-5.02"
}
]
}
], - "original_debts": [
- {
- "from": 18523,
- "to": 90261,
- "amount": "414.5",
- "currency_code": "USD"
}
], - "simplified_debts": [
- {
- "from": 18523,
- "to": 90261,
- "amount": "414.5",
- "currency_code": "USD"
}
], - "avatar": {
- "original": null,
}, - "custom_avatar": true,
}
}
Creates a new group. Adds the current user to the group by default.
Note: group user parameters must be flattened into the format users__{index}__{property}
, where
property
is user_id
, first_name
, last_name
, or email
.
The user's email or ID must be provided.
name required | string |
group_type | string Enum: "home" "trip" "couple" "other" "apartment" "house" What is the group used for? Note: It is recommended to use |
simplify_by_default | boolean Turn on simplify debts? |
users__{index}__{property}* | string |
{- "name": "The Brain Trust",
- "group_type": "trip",
- "users__0__first_name": "Alan",
- "users__0__last_name": "Turing",
- "users__0__email": "alan@example.org",
- "users__1__id": 5823
}
{- "group": {
- "id": 321,
- "name": "Housemates 2020",
- "group_type": "home",
- "updated_at": "2019-08-24T14:15:22Z",
- "simplify_by_default": true,
- "members": [
- {
- "id": 0,
- "first_name": "Ada",
- "last_name": "Lovelace",
- "email": "ada@example.com",
- "registration_status": "confirmed",
- "picture": {
- "small": "string",
- "medium": "string",
- "large": "string"
}, - "custom_picture": false,
- "balance": [
- {
- "currency_code": "USD",
- "amount": "-5.02"
}
]
}
], - "original_debts": [
- {
- "from": 18523,
- "to": 90261,
- "amount": "414.5",
- "currency_code": "USD"
}
], - "simplified_debts": [
- {
- "from": 18523,
- "to": 90261,
- "amount": "414.5",
- "currency_code": "USD"
}
], - "avatar": {
- "original": null,
}, - "custom_avatar": true,
}
}