growwapi SDK API Documentation
Overview
growwapi is the foundational SDK for accessing Groww APIs and listening to live data streams. This package provides the core functionalities to interact with Groww's trading platform.
Features
- Connect to Groww's API
- Place, modify, and cancel orders
- Retrieve order details, status, holdings, trade lists
- Subscribe and unsubscribe to market feeds
- Get live market data and updates
Installation
Install the package using pip:
pip install growwapi
Usage
Authentication
To use the SDK, you need to authenticate using your API credentials. Set the following variables:
API_AUTH_TOKEN: Your API authentication token.
API Client
The GrowwAPI class provides methods to interact with the Groww API.
from growwapi import GrowwAPI
groww_client = GrowwAPI("YOUR_API_KEY")
# Get the current orders. Will wait for 5 seconds or until the orders are received
orders = groww_client.get_order_list(timeout=5)
print(orders)
Feed Client
The GrowwFeed class provides methods to subscribe to and receive Groww data streams and updates.
It can either be used synchronously to get the last updated data or asynchronously to trigger a callback whenever new data is received.
from growwapi import GrowwFeed
from growwapi import GrowwAPI
groww_feed = GrowwFeed("YOUR_API_KEY")
# Synchronous Usage: Create a subscription and then get the LTP
groww_feed.subscribe_live_data(GrowwAPI.SEGMENT_CASH, "SWIGGY")
# Will wait for 3 seconds or until the LTP is received
ltp = groww_feed.get_stocks_ltp("SWIGGY", timeout=3)
print(ltp)
# Asynchronous Usage: Callback triggered whenever the LTP changes
def get_ltp_print():
# As it was triggerred on data received, we can directly get the LTP
ltp = groww_feed.get_stocks_ltp("RELIANCE")
print(ltp)
groww_feed.subscribe_live_data(GrowwAPI.SEGMENT_CASH, "RELIANCE", on_data_received=get_ltp_print)
Documentation
Metadata
Release files for growwapi 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| growwapi-1.5.0.tar.gz | 69.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| growwapi-1.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 145.6 kB
Release files / growwapi-1.5.0.tar.gz
| Download URL | growwapi-1.5.0.tar.gz |
|---|---|
| Size | 69.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
546be8517f1223dda1f5338a549b3499c2b7cabd1e165b64fef21ab386136b66
|
|
BLAKE2b-256 checksum How to use checksums |
9665c2e00e09d9f33593a5c6b8f06ded511cd1bf14cdf42c09f63c6a925b50ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|
Release files / growwapi-1.5.0-py3-none-any.whl
| Download URL | growwapi-1.5.0-py3-none-any.whl |
|---|---|
| Size | 76.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b4871ed19415b6ad7434bee2178f53aa1e180fbddd4a25693c458440f66939cc
|
|
BLAKE2b-256 checksum How to use checksums |
e1697dd0766c3a9dcf2688eb363a90fadca7a8388ac947efebd737b830bd478a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.6
|