Skip to main content

A Python wrapper for the Zerodha API that simplifies interaction with Zerodha's trading platform

Project description

Zerodha Wrapper

A Python wrapper for the Zerodha API that simplifies interaction with Zerodha's trading platform.

Features

  • Easy authentication with Zerodha
  • Automated login with TOTP support
  • Simplified order placement and position management
  • Functions for retrieving market data
  • Support for futures and options trading
  • Historical data retrieval
  • Margin checking utilities

Installation

pip install zerodhawrapper

Configuration

  1. Create a key.json file with your API credentials:
{
    "api_key": "your_api_key",
    "api_secret": "your_api_secret"
}
  1. Create a credentials.json file with your login credentials:
{
    "username": "your_zerodha_username",
    "password": "your_zerodha_password",
    "totp": "your_totp_secret"
}

Usage

from zerodhawrapper import initialize_kite, send_order, retrieve_positions

# Initialize the Kite connection
kite = initialize_kite()

# Place an order
order_id = send_order(
    kite=kite,
    symbol="INFY",
    quantity=1,
    transaction_type="BUY",
    order_type="MARKET",
    product="CNC"
)

# Get positions
positions = retrieve_positions(kite)

Available Functions

  • login(): Authenticate with Zerodha
  • initialize_kite(): Initialize KiteConnect client
  • get_quote(symbol): Get quote for a symbol
  • send_order(...): Place trading orders
  • retrieve_positions(kite): Get current positions
  • get_nifty50_futures_symbols(kite): Get Nifty50 futures symbols
  • get_nearest_nifty_fut_price(kite): Get nearest Nifty futures price
  • check_available_margin(kite): Check available trading margin
  • get_fno_underlyings(): Get F&O underlying symbols
  • get_historical(...): Get historical data
  • And many more...

Development

To contribute to this project:

  1. Clone the repository
  2. Install development dependencies: pip install -e .
  3. Make your changes
  4. Submit a pull request

License

MIT License

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

zerodhawrapper-1.3.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

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

zerodhawrapper-1.3-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file zerodhawrapper-1.3.tar.gz.

File metadata

  • Download URL: zerodhawrapper-1.3.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for zerodhawrapper-1.3.tar.gz
Algorithm Hash digest
SHA256 9293a9bb5027ebb33445ff32e34ae587c4dec774fa7b26be1db95902a03eb3a8
MD5 9d25f9846bce196fcef45788136fae1d
BLAKE2b-256 95b805afe6d6cd3e66ad7c253dccb26f143439fd27d89c4d807c2839c261b2ab

See more details on using hashes here.

File details

Details for the file zerodhawrapper-1.3-py3-none-any.whl.

File metadata

  • Download URL: zerodhawrapper-1.3-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for zerodhawrapper-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 be84109b5ffab90bd634687760014ad238c80b5e8576b5f2d6a480c8f1879dc8
MD5 1809365226abc6ba72d372c19eb76e29
BLAKE2b-256 fc55525fc547372bc2adeb3eace716c9aaaf53bbdb4984eef8b1b027392f3317

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