Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmohades/Venmo
Venmo API client for Python
https://github.com/mmohades/Venmo
api-wrapper venmo venmo-api
Last synced: 3 months ago
JSON representation
Venmo API client for Python
- Host: GitHub
- URL: https://github.com/mmohades/Venmo
- Owner: mmohades
- License: gpl-3.0
- Created: 2019-12-27T03:00:46.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-16T23:42:25.000Z (over 1 year ago)
- Last Synced: 2024-03-15T01:03:34.236Z (8 months ago)
- Topics: api-wrapper, venmo, venmo-api
- Language: Python
- Homepage:
- Size: 97.7 KB
- Stars: 134
- Watchers: 2
- Forks: 38
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mmohades/Venmo - Venmo API client for Python (Python)
README
# Venmo API
Disclaimer: This is an individual effort and is not PayPal/Venmo sponsored or maintained.
## Introduction
This is a wrapper for the Venmo API. This library provides a Python interface for the Venmo API. It's compatible with Python versions 3.6+.
## Installing
You can install or upgrade venmo-api with:
```bash
$ pip3 install venmo-api --upgrade
```
Or you can install it from the source:
```bash
$ git clone https://github.com/mmohades/Venmo.git --recursive
$ cd Venmo
$ python3 setup.py install
```
## Getting Started
### Usage
To use the API client, you first need to get your account's access token. Store your access token somewhere safe as anyone with the token can do everything with your Venmo account (e.g., transferring money). Also, make sure to revoke your access token once you are done using it using [log_out()](#revoke-token).
```python
from venmo_api import Client
# Get your access token. You will need to complete the 2FA process
# Please store it somewhere safe and use it next time
# Never commit your credentials or token to a git repository
access_token = Client.get_access_token(username='[email protected]',
password='your password')
print("My token:", access_token)
```
The following is an example of initializing and working with the api client.
```python
access_token = "YOUR_ACCESS_TOKEN"
# Initialize api client using an access-token
client = Client(access_token=access_token)
# Search for users. You get a maximum of 50 results per request.
users = client.user.search_for_users(query="Peter")
for user in users:
print(user.username)
# Or pass a callback to make it multi-threaded
def callback(users):
for user in users:
print(user.username)
client.user.search_for_users(query="peter",
callback=callback,
limit=10)
```
##### Revoke token
Keep this in mind that your access token never expires! You will need to revoke it yoursef:
```Python
client.log_out("Bearer a40fsdfhsfhdsfjhdkgljsdglkdsfj3j3i4349t34j7d")
```
##### Payment methods
Get all your payment methods to use one's id for sending_money
````python
payment_methods = client.payment.get_payment_methods()
for payment_method in payment_methods:
print(payment_method.to_json())
````
##### Sending or requesting money
```python
# Request money
client.payment.request_money(32.5, "house expenses", "0000000000000000000")
# Send money (with default payment method)
client.payment.send_money(13.68, "thanks for the 🍔", "0000000000000000000")
# Send money (with the provided payment method id)
client.payment.send_money(amount=13.68,
note="thanks for the 🍔",
target_user_id="0000000000000000000",
funding_source_id='9999999999999999999')
```
##### Transactions
Getting a user's transactions (only the ones that are visible to you, e.g, their `public` transactions)
```python
def callback(transactions_list):
for transaction in transactions_list:
print(transaction)
# callback is optional. Max number of transactions per request is 50.
client.user.get_user_transactions(user_id='0000000000000000000',
callback=callback)
```
##### Friends list
```python
# Get a user's friend's list
users = client.user.get_user_friends_list(user_id='0000000000000000000')
for user in users:
print(user)
```
##### Pagination
Here is a pagination example:
```python
# Get all the transactions possible (prints 50 per request until nothing has left)
transactions = client.user.get_user_transactions(user_id='0000000000000000000')
while transactions:
for transaction in transactions:
print(transaction)
print("\n" + "=" * 15 + "\n\tNEXT PAGE\n" + "=" * 15 + "\n")
transactions = transactions.get_next_page()
```
### Documentation
`venmo-api`'s documentation lives at [readthedocs.io](https://venmo.readthedocs.io/en/latest/).
## Contributing
Contributions of all sizes are welcome. You can help with the wrapper documentation located in /docs. You can also help by [reporting bugs](https://github.com/mmohades/VenmoApi/issues/new). You can add more routes to both [Venmo Unofficial API Documentation](https://github.com/mmohades/VenmoApiDocumentation) and the `venmo-api` wrapper.
## Venmo Unofficial API Documentation
You can find and contribute to the [Venmo Unofficial API Documentation](https://github.com/mmohades/VenmoApiDocumentation).