# 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
In short, you can send money, request for money, get a user's public transactions, get a user's public profile info, etc. The following is an example of initializing and working with it.
```python
from venmo_api import Client
# Get your access token. You will need to complete the 2FA process
access_token = Client.get_access_token(username='myemail@random.com',
password='your password')
venmo = Client(access_token=access_token)
# Search for users. You get 50 results per page.
users = venmo.user.search_for_users(query="Peter",
page=2)
for user in users:
print(user.username)
# Or, you can pass a callback to make it multi-threaded
def callback(users):
for user in users:
print(user.username)
venmo.user.search_for_users(query="peter",
callback=callback,
page=2,
count=10)
```
Keep this in mind that your access token never expires! You will need to revoke it by yoursef.
```Python
venmo.log_out("Bearer a40fsdfhsfhdsfjhdkgljsdglkdsfj3j3i4349t34j7d")
```
```python
# Request money
venmo.payment.request_money(32.5, "house expenses", "1122334455667")
```
```python
# Send money
venmo.payment.send_money(13.68, "thanks for the 🍔", "1122334455667")
```
Getting a user's transactions (public, friends and privates that happen between your account and user_id account)
```python
def callback(transactions_list):
for transaction in transactions_list:
print(transaction)
# callback is optional. Max number of transactions per request is 50.
venmo_api.user.get_user_transactions(user_id='0000000000000',
callback=callback)
```
### 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/mmohades/venmo",
"name": "venmo-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Python Venmo API wrapper",
"author": "Mark Mohades",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c7/ec/c4c0cda3bcde0a0f19b77162217783aee15b97607cacbeaf4d8d5d95cc7e/venmo-api-0.3.1.tar.gz",
"platform": "",
"description": "# Venmo API\n\nDisclaimer: This is an individual effort and is not PayPal/Venmo sponsored or maintained. \n\n## Introduction\n\nThis 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+.\n\n## Installing\n\nYou can install or upgrade venmo-api with:\n\n```bash\n$ pip3 install venmo-api --upgrade\n```\n\nOr you can install it from the source:\n\n```bash\n$ git clone https://github.com/mmohades/Venmo.git --recursive\n$ cd Venmo\n$ python3 setup.py install\n```\n\n## Getting Started\n\n### Usage\n\nIn short, you can send money, request for money, get a user's public transactions, get a user's public profile info, etc. The following is an example of initializing and working with it.\n\n ```python\nfrom venmo_api import Client\n\n# Get your access token. You will need to complete the 2FA process\naccess_token = Client.get_access_token(username='myemail@random.com',\n password='your password')\nvenmo = Client(access_token=access_token)\n\n# Search for users. You get 50 results per page.\nusers = venmo.user.search_for_users(query=\"Peter\",\n page=2)\nfor user in users:\n print(user.username)\n\n# Or, you can pass a callback to make it multi-threaded\ndef callback(users):\n for user in users:\n print(user.username)\nvenmo.user.search_for_users(query=\"peter\",\n callback=callback,\n page=2,\n count=10)\n\n ```\nKeep this in mind that your access token never expires! You will need to revoke it by yoursef.\n\n```Python\nvenmo.log_out(\"Bearer a40fsdfhsfhdsfjhdkgljsdglkdsfj3j3i4349t34j7d\")\n```\n\n```python\n# Request money\nvenmo.payment.request_money(32.5, \"house expenses\", \"1122334455667\")\n```\n\n```python\n# Send money\nvenmo.payment.send_money(13.68, \"thanks for the \ud83c\udf54\", \"1122334455667\")\n```\n\n\n\nGetting a user's transactions (public, friends and privates that happen between your account and user_id account)\n\n```python\ndef callback(transactions_list):\n for transaction in transactions_list:\n print(transaction)\n\n# callback is optional. Max number of transactions per request is 50.\nvenmo_api.user.get_user_transactions(user_id='0000000000000',\n callback=callback) \n```\n\n\n\n### Documentation\n\n`venmo-api`'s documentation lives at [readthedocs.io](https://venmo.readthedocs.io/en/latest/).\n\n## Contributing\n\nContributions 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. \n\n## Venmo Unofficial API Documentation\n\nYou can find and contribute to the [Venmo Unofficial API Documentation](https://github.com/mmohades/VenmoApiDocumentation).\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3",
"summary": "Venmo API client for Python",
"version": "0.3.1",
"split_keywords": [
"python",
"venmo",
"api",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ec8e3441b101993b1287d438fcce53da",
"sha256": "c94f3dfdb87bfc235b5df14a19312e676313f554950b1b5e3845c687465b2562"
},
"downloads": -1,
"filename": "venmo_api-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec8e3441b101993b1287d438fcce53da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 35727,
"upload_time": "2021-05-24T02:37:08",
"upload_time_iso_8601": "2021-05-24T02:37:08.568100Z",
"url": "https://files.pythonhosted.org/packages/0e/c5/52d441c5423008191c8108ae4a0c57272a6e0e2f99d764da62dc5ad3f588/venmo_api-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "39e787fc047afb227d0a5c3f2e7d63f7",
"sha256": "be65f2da6416773ccb7dde33bf3dc54fdf1cf9fad26b74a45c1302b4bee6a5cc"
},
"downloads": -1,
"filename": "venmo-api-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "39e787fc047afb227d0a5c3f2e7d63f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 31606,
"upload_time": "2021-05-24T02:37:09",
"upload_time_iso_8601": "2021-05-24T02:37:09.329168Z",
"url": "https://files.pythonhosted.org/packages/c7/ec/c4c0cda3bcde0a0f19b77162217783aee15b97607cacbeaf4d8d5d95cc7e/venmo-api-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-24 02:37:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mmohades",
"github_project": "venmo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.19.0"
]
]
}
],
"lcname": "venmo-api"
}
JSON
