This is the python sdk for Splitwise APIs. At this point only GET requests and a single POST request createExpense
is supported. Pull requests and bug reports are welcomed.
The latest version of splitwise SDK is Splitwise-0.0.5
Install using pip :
$ pip install splitwise
Register your application on splitwise and get your consumer key and consumer secret.
from splitwise import Splitwise
To get an instance to splitwise just provide the consumer key and secret.
sObj = Splitwise("<consumer key>","<consumer secret>")
To get the debug logs use
Splitwise.setDebug(True)
Before you can make call to splitwise, you need to get access token of the user on whose behalf you will be making call. Think of it as login with splitwise. Its based on OAuth2 and its a 2 step process.
-
Get the Authorize URL and Secret. Redirect the user to the Authorize url and store the secret in somewhere for eg in session.
sObj = Splitwise("<consumer key>","<consumer secret>") url, secret = sObj.getAuthorizeURL() #Store secret so you can retrieve it later #redirect user to url
-
After authorization splitwise will redirect the user back to the callback url that you provided during registration. It will also provide oauth_token and oauth_verifier that can be used along with secret from step 1 to get access token. The below snippet is from Flask application to extract parameters and then using SDK to get access token. This access token can be stored in your db to make calls on his/her behalf.
oauth_token = request.args.get('oauth_token') oauth_verifier = request.args.get('oauth_verifier') sObj = Splitwise(Config.consumer_key,Config.consumer_secret) access_token = sObj.getAccessToken(oauth_token,session['secret'],oauth_verifier) session['access_token'] = access_token
Once you have the access token you can make the calls to splitwise. Get the splitwise instance and set the access token and then make authorized calls.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getFriends()
You can use getCurrentUser()
to get the current user. It returns a CurrentUser
object.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getCurrentUser()
You can use getUser(id)
to get the user. It returns a User
object.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
id = 7123
user = sObj.getUser(id)
You can use getFriends()
to get all the friends of the current user along with the balances. It returns a list of Friend
objects.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getFriends()
You can use getGroups()
to get all the groups of the current user along with the members and balances. It returns a list of Group
objects.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getGroups()
You can use getCurrencies()
to get all the currencies supported by splitwise. It returns a list of Currency
objects.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getCurrencies()
You can use getCategories()
to get all the categories and sub categories provided by splitwise. It returns a list of Category
objects.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getCategories()
You can use getGroup(id)
to get the particular group of the current user along with the members and balances. It returns a Group
object. Use id as 0 to get all non group expenses.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getGroup(43233)
You can use getExpenses(offset,limit,group_id,friendship_id,dated_after,dated_before,updated_after,updated_before)
to get all the expenses of the current user based on filter options. It returns a list of Expense
objects.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getExpenses()
You can use getExpense(id)
to get the particular expense of the current user. It returns a Expense
object.
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
sObj.getExpense(43233)
You can use createExpense(Expense)
to create a new Expense. It takes in parameter a partial Expense
object and returns an Expense
object.
Following things need to be set on the Expense
object.
- Cost
- Description
- Users - Should be a list of
ExpenseUser
with id and paidShare and owedShare set.
from splitwise.expense import Expense
from splitwise.user import ExpenseUser
sObj = Splitwise(Config.consumer_key,Config.consumer_secret)
sObj.setAccessToken(session['access_token'])
expense = Expense()
expense.setCost('10')
expense.setDescription("Testing")
user1 = ExpenseUser()
user1.setId(79774)
user1.setPaidShare('10.00')
user1.setOwedShare('2.0')
user2 = ExpenseUser()
user2.setId(281236)
user2.setPaidShare('0.00')
user2.setOwedShare('8.00')
users = []
users.append(user1)
users.append(user2)
expense.setUsers(users)
expense = sObj.createExpense(expense)
print expense.getId()
Methods:
- getId() - Returns the id of the user
- getFirstName() - Returns the first name of user
- getLastName() - Returns the last name of user
- getEmail() - Returns the email of the user
- getRegistrationStatus() - Returns the registraion status of the user
- getPicture() - Returns a
Picture
object containing picture details
Current user is inherited from User
. All the methods of user are available for current user.
Methods:
- getDefaultCurrency() - Returns the default currency
- getLocale() - Returns the locale
- getDateFormat() - Returns the date format
- getDefaultGroupId() - Returns the default group id of user
Friend is inherited from User
. All the methods of user are available for friend.
Methods:
- getUpdatedAt() - Gets the time when this user information was last updated
- getBalances() - Returns a list of
Balance
objects - getGroups() - Returns a list of
FriendGroup
objects
ExpenseUser is inherited from User
. All the methods of user are available for Expense User.
Methods:
- getPaidShare() - Returns the Paid Share
- getOwedShare() - Returns the Owed Share
- getNetBalance() - Returns the Net Balance
Methods:
- getId() - Returns the id of the group
- getName() - Returns the name of the group
- getUpdatedAt() - Get the time this group was last updated
- getWhiteBoard() - Get the whiteboard contents of this group
- isSimplifiedByDefault() - Returns if group is simplified by default or not
- getMembers() - Returns a list of
Friend
objects - getOriginalDebts() - Returns a list of
Debt
objects - getType() - Returns the type of group
- getSimplifiedDebts() - Returns a list of
Debt
objects - getInviteLink() - Returns the invite link
Methods:
- getId() - Returns the id of the group
- getBalances() - Returns a list of
Balance
object
Methods:
- getCurrencyCode() - Returns the currency code.
- getAmount() - Returns the amount
Methods:
- getSubcategories() - Returns a list of
Category
objects - getId() - Returns the id of category
- getName() - Returns the name of the category
Methods:
- getCode() - Returns the Currency Code
- getUnit() - Returns the Currency Unit
Methods:
- getFromUser() - Returns the id of the from user
- getToUser() - Returns the id of the to user
- getAmount() - Returns the amount of the debt
- getCurrencyCode() - Returns the currency code of debt
Methods:
- getId() - Returns the id of expense
- getGroupId() - Returns the id of the group expense belongs to
- getDescription() - Returns the description of expense
- isRepeat() - Returns if expense is repeat or not
- getRepeatInterval() - Returns the repeat interval of expense
- getEmailReminder() - Returns Email reminder
- getEmailReminderInAdvance() - Returns email reminder in advance
- getNextRepeat() - Returns the time of next repeat
- getDetails() - Returns the detail of expense
- getCommentsCount() - Returns the number of comments
- getPayment() - Returns the payment of expense
- getCreationMethod() - Returns the creation method of expense
- getTransactionMethod() - Returns the transaction method of expense
- getTransactionConfirmed() - Returns if transaction is confirmed
- getCost() - Returns the cost of transaction
- getCurrencyCode() - Returns the currency code of transaction
- getCreatedBy() - Returns a
User
object of user who created the expense - getDate() - Returns the expense date.
- getCreatedAt() - Returns the date time expense was created
- getUpdatedAt() - Returns the date time expense was last updated
- getDeletedAt() - Returns the date time expense was deleted
- getReceipt() - Returns a
Receipt
object for receipt - getCategory() - Returns a
Category
object for category - getUpdatedBy() - Returns a
User
object of user who last updated the expense - getDeletedBy() - Returns a
User
object of user who deleted the expense - getUsers() - Returns a list of
ExpenseUser
objects - getExpenseBundleId() - Returns Expense Bundle ID
- getFriendshipId() - Returns the Friendship ID
- getRepayments() - Returns a list of
Debt
objects
Methods:
- getSmall() - Returns the link to the small image
- getMedium() - Returns the link to the medium image
- getLarge() - Returns the link to the large image
Methods:
- getOriginal() - Returns the link to the original uploaded receipt
- getLarge() - Returns the link to large image of uploaded receipt
This is the GitHub Link to the sample application written in Flask to show the usage of splitwise application.
MIT
If you think this helped you and you want to donate, you can do it via -
https://www.paypal.me/namanagg
1DNhyZ696ekq6sY5vYMcmBLxLzAtq3oYpM