Skip to main content

Unofficial Public.com Invest API written in Python Requests

Project description

Unofficial Public.com Invest API

This is an unofficial API for Public.com. It is a simple Python wrapper around the Public.com requests API. It is not affiliated with Public.com in any way. Use at your own risk.

This is still a very work in progress, so it will have bugs and missing features. Feel free to contribute!

Installation

pip install public-invest-api

Usage: Logging In

from public_invest_api import Public

public = Public()
public.login(
    username='your_email',
    password='your_password',
    wait_for_2fa=True # When logging in for the first time, you need to wait for the SMS code
)

If you'd like to handle the 2FA code yourself, set wait_for_2fa=False and it will throw an Exception relating to 2FA. Catch this, then when you get the 2FA code, call it again with the code:

public.login(
    username='your_email',
    password='your_password',
    wait_for_2fa=False,
    code='your_2fa_code' # Should be six digit integer
)

Usage: Get Holdings

positions = public.get_positions()
for position in positions:
    print(position)

Usage: Placing Orders

order = public.place_order(
    symbol='AAPL',
    quantity=1,
    side='BUY', # or 'SELL'
    order_type='MARKET', # or 'LIMIT' or 'STOP'
    limit_price=None # pass float if using 'LIMIT' order_type
    time_in_force='DAY', # or 'GTC' or 'IOC' or 'FOK'
    is_dry_run=False, # If True, it will not actually place the order
    tip=0 # The amount to tip Public.com
)
print(order)

Contributing

Found or fixed a bug? Have a feature request? Feel free to open an issue or pull request!

Enjoying the project? Feel free to Sponsor me on GitHub or Ko-fi!

Sponsor ko-fi

DISCLAIMER

DISCLAIMER: I am not a financial advisor and not affiliated with Public.com. Use this tool at your own risk. I am not responsible for any losses or damages you may incur by using this project. This tool is provided as-is with no warranty.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

public_invest_api-1.0.4.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

public_invest_api-1.0.4-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file public_invest_api-1.0.4.tar.gz.

File metadata

  • Download URL: public_invest_api-1.0.4.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for public_invest_api-1.0.4.tar.gz
Algorithm Hash digest
SHA256 7d1a5877ab07f9f27605a85c53daf6dddd9f644deb8ac39a81e342b63f280fe5
MD5 32a972a034363ca7cf13e4b22efd3846
BLAKE2b-256 532942380430dccea25034f5f00280b19ab35e5629966748464495bf3ad18425

See more details on using hashes here.

File details

Details for the file public_invest_api-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for public_invest_api-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 469bf4cc265814dd8b80c87aa28b9e672223fdbc2953eb76d2d16b50066f20ab
MD5 4d96ec60b82400d7290bed94c6ffe182
BLAKE2b-256 e1384041ad09c8db5578e5166e84c93525381161ce66a8ac53a7883b0cac0201

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page