Usage Examples

This section provides practical examples for using nepse-client in various scenarios.

Example Categories

Basic Usage

Learn the fundamentals:

  • Basic Usage Examples - Simple synchronous examples

  • Market data fetching

  • Company information

  • Error handling basics

Asynchronous Usage

Master async patterns:

  • Asynchronous Usage - Concurrent operations

  • Multiple requests

  • Performance optimization

  • Context managers

Advanced Examples

Complex scenarios:

  • Advanced Examples - Real-world applications

  • Portfolio management

  • Data analysis

  • Custom integrations

Quick Examples

Get Market Status

from nepse_client import NepseClient

client = NepseClient()
status = client.getMarketStatus()

print(f"Market is: {status['isOpen']}")
print(f"As of: {status['asOf']}")

Get Top Gainers

from nepse_client import NepseClient

client = NepseClient()
gainers = client.getTopGainers()

print("Top 5 Gainers:")
for i, stock in enumerate(gainers[:5], 1):
   print(f"{i}. {stock['symbol']}: +{stock['percentageChange']}%")

Async Concurrent Requests

import asyncio
from nepse_client import AsyncNepseClient

async def main():
   async with AsyncNepseClient() as client:
      # Fetch multiple data concurrently
      status, summary, gainers = await asyncio.gather(
         client.getMarketStatus(),
         client.getSummary(),
         client.getTopGainers()
      )

      print(f"Market: {status['isOpen']}")
      print(f"Turnover: NPR {summary['totalTurnover']:,.2f}")
      print(f"Top Gainer: {gainers[0]['symbol']}")

asyncio.run(main())

Example Projects

GitHub Repository

Find complete example projects in the examples/ directory:

  • basic_usage.py - Fundamental examples

  • async_usage.py - Async patterns

  • advanced_usage.py - Complex scenarios

  • error_handling.py - Error management

  • django_integration.py - Django integration

Running Examples

# Clone repository
git clone https://github.com/4mritgiri/NepseClient.git
cd nepse-client

# Install
pip install -e .

# Run examples
python examples/basic_usage.py
python examples/async_usage.py

Community Examples

Check out community-contributed examples:

Contributing Examples

Have an interesting use case? Share it!

  1. Create your example

  2. Test thoroughly

  3. Add documentation

  4. Submit a pull request

See Contributing Guide for guidelines.

Need Help?