prosper-api 0.11.0

Python trading library for Prosper.com

Prosper API client for Python

Python trading library for Prosper.com

Installation

With Pip

pip install prosper-api

Optional keyring support

pip install 'prosper-api[secure]'

With Poetry

poetry add prosper-api

Optional keyring support

poetry add 'prosper-api[secure]'

Setup

ℹ️ The library currently only supports personal use, where the client id and credentials are from the same account. Support for multi-account mode is planned.

Config file location

• Linux/Unix: $HOME/.config/prosper-api/config.toml
• Windows: %HOMEDIR%%HOMEPATH\AppData\Local\prosper-api\prosper-api\config.toml
• MacOs: $HOME/Library/Application Support/prosper-api/config.toml

Default

Create a config file with the following contents:

[credentials]
client-id = "0123456789abcdef0123456789abcdef"
client-secret = "fedcba9876543210fedcba9876543210"
username = "PROBABLY_YOUR_EMAIL_ADDRESS"
password = "AWESOME_PASSWORD"

More secure

ℹ️ You must have installed keyring or used the '[secure]' mode when installing the library.

Remove the client-secret and password portions of the config:

[credentials]
client-id = "0123456789abcdef0123456789abcdef"
username = "PROBABLY_YOUR_EMAIL_ADDRESS"

Run the following to store your credentials securely in your OS credentials storage, e.g. Keychain for MacOS, etc. For each command, you will be prompted to enter the corresponding secret. For 'CLIENT_ID', enter the client secret. For 'USERNAME' enter the corresponding password.

keyring set prosper-api '{CLIENT_ID}'
keyring set prosper-api '{USERNAME}'

Use

See a sample bot for concrete usage.

Get account details

The following will get the details of your account, including available cash and investment allocations.

from prosper_api.client import Client
from prosper_api.models import Account

client = Client()
account: Account = client.get_account_info()

Search listings

The following will get all the current listings you haven't invested in.

from prosper_api.client import Client
from prosper_api.models import Listing, SearchListingsRequest, SearchListingsResponse
from typing import List

PAGE_SIZE=25
client = Client()
listings: List[Listing] = []
offset = 0
while True:
    result: SearchListingsResponse = client.search_listings(SearchListingsRequest(invested=False, biddable=True, limit=PAGE_SIZE, offset=offset))
    listings += result.result
    offset += PAGE_SIZE
    if len(listings) >= result.total_count or len(result.result) < PAGE_SIZE:
        break

ℹ️ The full set of filters listed in the Prosper API docs are available

Place order

The following will place an order, given a listing id.

from prosper_api.client import Client
from prosper_api.models import Order

client = Client()
listing_id: int = 12341234
order_dollar_amount: float = 25
order_result: Order = client.order(listing_id, order_dollar_amount)

List notes

The following will list all the notes in your account. The same pattern can be used to list orders, loans, and payments.

from prosper_api.client import Client
from prosper_api.models import Note, ListNotesRequest, ListNotesResponse
from typing import List

client = Client()
notes: List[Note] = []
PAGE_SIZE = 25
offset = 0
while True:
    result: ListNotesResponse = client.list_notes(ListNotesRequest(limit=PAGE_SIZE, offset=offset, sort_by="age_in_months", sort_dir="asc"))
    notes += result.result
    offset += PAGE_SIZE
    if len(notes) >= result.total_count or len(result.result) < PAGE_SIZE:
        break

Configuration

Available config values:

["prosper-api.credentials.client-id"]
type = "str"
optional = false
constraint = "^[a-f0-9]{32}$"
description = "The client-id from Prosper."

["prosper-api.credentials.client-secret"]
type = "str"
optional = true
constraint = "^[a-f0-9]{32}$"
description = "The client-secret from Prosper; can be stored and accessed securely using the keyring library."

["prosper-api.credentials.username"]
type = "str"
optional = false
description = "Your Prosper username"

["prosper-api.credentials.password"]
type = "str"
optional = true
description = "Your Prosper password; can be stored and accessed securely using the keyring library."

["prosper-api.auth.token-cache"]
type = "str"
optional = false
default = "/Users/graham/Library/Caches/prosper-api/token-cache"
description = "The filesystem location where the auth token will be cached."

Feedback

This project uses GitHub issues for feature requests and bug reports.

Contributing

This project uses Poetry to manage dependencies and building. Follow the instructions to install it. Then use poetry install --all-extras to install the project dependencies. Then run poetry run autohooks activate to set up the pre-commit hooks. Please ensure the hooks pass before submitting a pull request.