NEPSE Client

Getting Started

  • Installation
    • Requirements
      • Supported Platforms
    • Installation Methods
      • From PyPI (Recommended)
      • Using uv (Fast)
      • Using poetry
      • Using pipenv
      • From Source
      • Development Installation
    • Dependencies
      • Core Dependencies
      • Optional Dependencies
    • Upgrading
    • Uninstallation
    • Virtual Environments
      • Using venv
      • Using conda
    • Troubleshooting
      • Import Error
      • SSL Certificate Error
      • Permission Denied
      • Version Conflicts
    • Verifying Installation
    • Next Steps
    • Support
  • Quickstart Guide
    • Installation
    • Basic Usage
      • Synchronous Client
      • Asynchronous Client
    • Common Operations
      • Market Information
      • Company Data
      • Trading Data
      • Top Performers
    • Error Handling
    • Context Managers
    • Configuration
      • Custom Timeout
      • TLS Verification
      • Custom Logging
    • Complete Example
    • Next Steps
    • Tips and Best Practices
    • Troubleshooting
      • Import Error
      • Connection Errors
      • Rate Limiting
    • Getting Help

Usage Examples

  • Usage Examples
    • Basic Usage Examples
      • Getting Started
        • Simple Market Data
    • Asynchronous Usage
      • Basic Async Example
    • Advanced Examples
      • Portfolio Calculator
    • Example Categories
      • Basic Usage
      • Asynchronous Usage
      • Advanced Examples
    • Quick Examples
      • Get Market Status
      • Get Top Gainers
      • Async Concurrent Requests
    • Example Projects
      • GitHub Repository
      • Running Examples
    • Community Examples
    • Contributing Examples
    • Need Help?
  • Basic Usage Examples
    • Getting Started
      • Simple Market Data
  • Asynchronous Usage
    • Basic Async Example
  • Advanced Examples
    • Portfolio Calculator

API Reference

  • API Reference
    • Overview
      • nepse_client Package
        • NepseClient
        • AsyncNepseClient
        • NepseError
        • NepseClientError
        • NepseServerError
        • NepseAuthenticationError
        • NepseNetworkError
        • NepseValidationError
        • NepseBadGatewayError
        • NepseRateLimitError
        • NepseDataNotFoundError
        • NepseTimeoutError
        • NepseConnectionError
        • NepseConfigurationError
        • Main Classes
        • Package Metadata
        • Submodules
      • Client Classes
        • Base Client
        • NepseClient (Synchronous)
        • AsyncNepseClient (Asynchronous)
        • Token Management
        • Dummy ID Management
        • Configuration
        • Performance Considerations
        • Best Practices
      • Exception Handling
        • NepseError
        • NepseClientError
        • NepseAuthenticationError
        • NepseBadGatewayError
        • NepseServerError
        • NepseNetworkError
        • NepseValidationError
        • NepseRateLimitError
        • NepseDataNotFoundError
        • NepseTimeoutError
        • NepseConnectionError
        • NepseConfigurationError
        • get_exception_for_status()
        • Exception Hierarchy
        • Base Exception
        • Client Errors
        • Authentication Errors
        • Server Errors
        • Network Errors
        • Rate Limiting
        • Data Errors
        • Configuration Errors
        • Error Handling Best Practices
      • Utilities
        • Helper Functions
        • Token Parser
        • Data Type Conversions
        • Type Annotations
        • Configuration Loading
        • Logging Utilities
        • Response Processing
        • Caching Mechanisms
        • Progress Tracking
        • Pagination Helpers
        • Testing Utilities
        • Constants
    • Main Modules
      • nepse_client
        • nepse_client.NepseClient
        • nepse_client.AsyncNepseClient
      • Client Modules
        • nepse_client.client
        • nepse_client.sync_client
        • nepse_client.async_client
      • Support Modules
        • nepse_client.token_manager
        • nepse_client.dummy_id_manager
      • Exception Handling
        • nepse_client.exceptions
    • Package Information
      • Version Information
      • Available Exports
    • Usage Examples
      • Basic Import
      • Exception Handling
      • Type Hints
    • Module Index
  • nepse_client Package
    • NepseClient
      • NepseClient.__enter__()
      • NepseClient.__exit__()
      • NepseClient.__init__()
      • NepseClient.close()
      • NepseClient.getAuthorizationHeaders()
      • NepseClient.getCompanyAGM()
      • NepseClient.getCompanyDetails()
      • NepseClient.getCompanyDividend()
      • NepseClient.getCompanyFinancialDetails()
      • NepseClient.getCompanyIDKeyMap()
      • NepseClient.getCompanyList()
      • NepseClient.getCompanyMarketDepth()
      • NepseClient.getCompanyNewsList()
      • NepseClient.getCompanyPriceVolumeHistory()
      • NepseClient.getDailyBankSubindexGraph()
      • NepseClient.getDailyDevelopmentBankSubindexGraph()
      • NepseClient.getDailyFinanceSubindexGraph()
      • NepseClient.getDailyFloatIndexGraph()
      • NepseClient.getDailyHotelTourismSubindexGraph()
      • NepseClient.getDailyHydroSubindexGraph()
      • NepseClient.getDailyInvestmentSubindexGraph()
      • NepseClient.getDailyLifeInsuranceSubindexGraph()
      • NepseClient.getDailyManufacturingSubindexGraph()
      • NepseClient.getDailyMicrofinanceSubindexGraph()
      • NepseClient.getDailyMutualfundSubindexGraph()
      • NepseClient.getDailyNepseIndexGraph()
      • NepseClient.getDailyNonLifeInsuranceSubindexGraph()
      • NepseClient.getDailyOthersSubindexGraph()
      • NepseClient.getDailyScripPriceGraph()
      • NepseClient.getDailySensitiveFloatIndexGraph()
      • NepseClient.getDailySensitiveIndexGraph()
      • NepseClient.getDailyTradingSubindexGraph()
      • NepseClient.getDebentureAndBondList()
      • NepseClient.getFloorSheet()
      • NepseClient.getFloorSheetOf()
      • NepseClient.getHolidayList()
      • NepseClient.getNepseNotice()
      • NepseClient.getNewsAndAlertList()
      • NepseClient.getPOSTPayloadID()
      • NepseClient.getPOSTPayloadIDForFloorSheet()
      • NepseClient.getPOSTPayloadIDForScrips()
      • NepseClient.getPressRelease()
      • NepseClient.getPriceVolumeHistory()
      • NepseClient.getSectorScrips()
      • NepseClient.getSecurityIDKeyMap()
      • NepseClient.getSecurityList()
      • NepseClient.getSymbolMarketDepth()
      • NepseClient.init_client()
      • NepseClient.requestGETAPI()
      • NepseClient.requestPOSTAPI()
      • NepseClient.headers
      • NepseClient.company_symbol_id_keymap
      • NepseClient.security_symbol_id_keymap
      • NepseClient.company_list
      • NepseClient.security_list
      • NepseClient.holiday_list
      • NepseClient.sector_scrips
    • AsyncNepseClient
      • AsyncNepseClient.__aenter__()
      • AsyncNepseClient.__aexit__()
      • AsyncNepseClient.__init__()
      • AsyncNepseClient.close()
      • AsyncNepseClient.getAuthorizationHeaders()
      • AsyncNepseClient.getCompanyDetails()
      • AsyncNepseClient.getCompanyIDKeyMap()
      • AsyncNepseClient.getCompanyList()
      • AsyncNepseClient.getCompanyPriceVolumeHistory()
      • AsyncNepseClient.getDailyScripPriceGraph()
      • AsyncNepseClient.getFloorSheet()
      • AsyncNepseClient.getFloorSheetOf()
      • AsyncNepseClient.getLiveMarket()
      • AsyncNepseClient.getMarketStatus()
      • AsyncNepseClient.getNepseIndex()
      • AsyncNepseClient.getNepseSubIndices()
      • AsyncNepseClient.getPOSTPayloadID()
      • AsyncNepseClient.getPOSTPayloadIDForFloorSheet()
      • AsyncNepseClient.getPOSTPayloadIDForScrips()
      • AsyncNepseClient.getPriceVolume()
      • AsyncNepseClient.getSectorScrips()
      • AsyncNepseClient.getSecurityIDKeyMap()
      • AsyncNepseClient.getSecurityList()
      • AsyncNepseClient.getSummary()
      • AsyncNepseClient.getSupplyDemand()
      • AsyncNepseClient.getSymbolMarketDepth()
      • AsyncNepseClient.getTopGainers()
      • AsyncNepseClient.getTopLosers()
      • AsyncNepseClient.getTopTenTradeScrips()
      • AsyncNepseClient.getTopTenTransactionScrips()
      • AsyncNepseClient.getTopTenTurnoverScrips()
      • AsyncNepseClient.getTradingAverage()
      • AsyncNepseClient.init_client()
      • AsyncNepseClient.requestGETAPI()
      • AsyncNepseClient.requestPOSTAPI()
      • AsyncNepseClient.headers
      • AsyncNepseClient.company_symbol_id_keymap
      • AsyncNepseClient.security_symbol_id_keymap
      • AsyncNepseClient.company_list
      • AsyncNepseClient.security_list
      • AsyncNepseClient.holiday_list
      • AsyncNepseClient.sector_scrips
    • NepseError
      • NepseError.message
      • NepseError.status_code
      • NepseError.response_data
      • NepseError.request_data
      • NepseError.__init__()
      • NepseError.__repr__()
      • NepseError.__str__()
      • NepseError.to_dict()
    • NepseClientError
      • NepseClientError.__init__()
    • NepseServerError
      • NepseServerError.__init__()
    • NepseAuthenticationError
      • NepseAuthenticationError.__init__()
    • NepseNetworkError
      • NepseNetworkError.__init__()
    • NepseValidationError
      • NepseValidationError.__init__()
    • NepseBadGatewayError
      • NepseBadGatewayError.__init__()
    • NepseRateLimitError
      • NepseRateLimitError.retry_after
      • NepseRateLimitError.__init__()
    • NepseDataNotFoundError
      • NepseDataNotFoundError.__init__()
    • NepseTimeoutError
      • NepseTimeoutError.timeout
      • NepseTimeoutError.__init__()
    • NepseConnectionError
      • NepseConnectionError.__init__()
    • NepseConfigurationError
      • NepseConfigurationError.__init__()
    • Main Classes
      • NepseClient
        • NepseClient
      • AsyncNepseClient
        • AsyncNepseClient
    • Package Metadata
      • Version
        • __version__
      • Author
        • __author__
    • Submodules
      • client
        • mask_sensitive_data()
        • safe_serialize()
      • sync_client
        • NepseClient
      • async_client
        • AsyncNepseClient
      • token_manager
        • TokenManager
        • AsyncTokenManager
        • TokenParser
      • dummy_id_manager
        • DummyIDManager
        • AsyncDummyIDManager
      • exceptions
        • NepseError
        • NepseClientError
        • NepseAuthenticationError
        • NepseBadGatewayError
        • NepseServerError
        • NepseNetworkError
        • NepseValidationError
        • NepseRateLimitError
        • NepseDataNotFoundError
        • NepseTimeoutError
        • NepseConnectionError
        • NepseConfigurationError
        • get_exception_for_status()
  • Client Classes
    • Base Client
      • mask_sensitive_data()
      • safe_serialize()
    • NepseClient (Synchronous)
      • NepseClient
        • NepseClient.__init__()
        • NepseClient.init_client()
        • NepseClient.__enter__()
        • NepseClient.__exit__()
        • NepseClient.close()
        • NepseClient.requestGETAPI()
        • NepseClient.requestPOSTAPI()
        • NepseClient.getAuthorizationHeaders()
        • NepseClient.getPOSTPayloadIDForScrips()
        • NepseClient.getPOSTPayloadID()
        • NepseClient.getPOSTPayloadIDForFloorSheet()
        • NepseClient.getCompanyList()
        • NepseClient.getSecurityList()
        • NepseClient.getCompanyIDKeyMap()
        • NepseClient.getSecurityIDKeyMap()
        • NepseClient.getSectorScrips()
        • NepseClient.getCompanyDetails()
        • NepseClient.getCompanyFinancialDetails()
        • NepseClient.getCompanyAGM()
        • NepseClient.getCompanyDividend()
        • NepseClient.getCompanyMarketDepth()
        • NepseClient.getCompanyPriceVolumeHistory()
        • NepseClient.getDailyScripPriceGraph()
        • NepseClient.getFloorSheet()
        • NepseClient.getFloorSheetOf()
        • NepseClient.getSymbolMarketDepth()
        • NepseClient.getHolidayList()
        • NepseClient.getDebentureAndBondList()
        • NepseClient.getCompanyNewsList()
        • NepseClient.getNewsAndAlertList()
        • NepseClient.getPressRelease()
        • NepseClient.getNepseNotice()
        • NepseClient.getPriceVolumeHistory()
        • NepseClient.getDailyNepseIndexGraph()
        • NepseClient.getDailySensitiveIndexGraph()
        • NepseClient.getDailyFloatIndexGraph()
        • NepseClient.getDailySensitiveFloatIndexGraph()
        • NepseClient.getDailyBankSubindexGraph()
        • NepseClient.getDailyDevelopmentBankSubindexGraph()
        • NepseClient.getDailyFinanceSubindexGraph()
        • NepseClient.getDailyHotelTourismSubindexGraph()
        • NepseClient.getDailyHydroSubindexGraph()
        • NepseClient.getDailyInvestmentSubindexGraph()
        • NepseClient.getDailyLifeInsuranceSubindexGraph()
        • NepseClient.getDailyManufacturingSubindexGraph()
        • NepseClient.getDailyMicrofinanceSubindexGraph()
        • NepseClient.getDailyMutualfundSubindexGraph()
        • NepseClient.getDailyNonLifeInsuranceSubindexGraph()
        • NepseClient.getDailyOthersSubindexGraph()
        • NepseClient.getDailyTradingSubindexGraph()
      • Market Data Methods
        • NepseClient.getMarketStatus()
        • NepseClient.getSummary()
        • NepseClient.getNepseIndex()
        • NepseClient.getNepseSubIndices()
        • NepseClient.getLiveMarket()
        • NepseClient.getPriceVolume()
        • NepseClient.getSupplyDemand()
      • Company Information Methods
        • NepseClient.getCompanyList()
        • NepseClient.getSecurityList()
        • NepseClient.getCompanyDetails()
        • NepseClient.getCompanyPriceVolumeHistory()
        • NepseClient.getDailyScripPriceGraph()
        • NepseClient.getCompanyFinancialDetails()
        • NepseClient.getCompanyAGM()
        • NepseClient.getCompanyDividend()
      • Trading Data Methods
        • NepseClient.getFloorSheet()
        • NepseClient.getFloorSheetOf()
        • NepseClient.getSymbolMarketDepth()
        • NepseClient.getTradingAverage()
      • Top Performers Methods
        • NepseClient.getTopGainers()
        • NepseClient.getTopLosers()
        • NepseClient.getTopTenTradeScrips()
        • NepseClient.getTopTenTransactionScrips()
        • NepseClient.getTopTenTurnoverScrips()
      • Utility Methods
        • NepseClient.getCompanyIDKeyMap()
        • NepseClient.getSecurityIDKeyMap()
        • NepseClient.getSectorScrips()
        • NepseClient.setTLSVerification()
    • AsyncNepseClient (Asynchronous)
      • AsyncNepseClient
        • AsyncNepseClient.__init__()
        • AsyncNepseClient.init_client()
        • AsyncNepseClient.__aenter__()
        • AsyncNepseClient.__aexit__()
        • AsyncNepseClient.close()
        • AsyncNepseClient.requestGETAPI()
        • AsyncNepseClient.requestPOSTAPI()
        • AsyncNepseClient.getAuthorizationHeaders()
        • AsyncNepseClient.getPOSTPayloadIDForScrips()
        • AsyncNepseClient.getPOSTPayloadID()
        • AsyncNepseClient.getPOSTPayloadIDForFloorSheet()
        • AsyncNepseClient.getMarketStatus()
        • AsyncNepseClient.getPriceVolume()
        • AsyncNepseClient.getSummary()
        • AsyncNepseClient.getTopGainers()
        • AsyncNepseClient.getTopLosers()
        • AsyncNepseClient.getTopTenTradeScrips()
        • AsyncNepseClient.getTopTenTransactionScrips()
        • AsyncNepseClient.getTopTenTurnoverScrips()
        • AsyncNepseClient.getSupplyDemand()
        • AsyncNepseClient.getNepseIndex()
        • AsyncNepseClient.getNepseSubIndices()
        • AsyncNepseClient.getLiveMarket()
        • AsyncNepseClient.getTradingAverage()
        • AsyncNepseClient.getCompanyList()
        • AsyncNepseClient.getSecurityList()
        • AsyncNepseClient.getCompanyIDKeyMap()
        • AsyncNepseClient.getSecurityIDKeyMap()
        • AsyncNepseClient.getSectorScrips()
        • AsyncNepseClient.getCompanyDetails()
        • AsyncNepseClient.getCompanyPriceVolumeHistory()
        • AsyncNepseClient.getDailyScripPriceGraph()
        • AsyncNepseClient.getFloorSheet()
        • AsyncNepseClient.getFloorSheetOf()
        • AsyncNepseClient.getSymbolMarketDepth()
    • Token Management
      • TokenManager
        • TokenManager.__init__()
        • TokenManager.getAccessToken()
        • TokenManager.getRefreshToken()
        • TokenManager.update()
      • AsyncTokenManager
        • AsyncTokenManager.__init__()
        • AsyncTokenManager.getAccessToken()
        • AsyncTokenManager.getRefreshToken()
        • AsyncTokenManager.update()
      • TokenParser
        • TokenParser.__init__()
        • TokenParser.parse_token_response()
      • TokenManager (Synchronous)
        • TokenManager
      • AsyncTokenManager (Asynchronous)
        • AsyncTokenManager
    • Dummy ID Management
      • DummyIDManager
        • DummyIDManager.__init__()
        • DummyIDManager.populateData()
        • DummyIDManager.getDummyID()
      • AsyncDummyIDManager
        • AsyncDummyIDManager.__init__()
        • AsyncDummyIDManager.populateData()
        • AsyncDummyIDManager.getDummyID()
      • DummyIDManager (Synchronous)
        • DummyIDManager
      • AsyncDummyIDManager (Asynchronous)
        • AsyncDummyIDManager
    • Configuration
    • Performance Considerations
      • Synchronous vs Asynchronous
      • Caching
    • Best Practices
  • Exception Handling
    • NepseError
      • NepseError.message
      • NepseError.status_code
      • NepseError.response_data
      • NepseError.request_data
      • NepseError.__init__()
      • NepseError.__str__()
      • NepseError.__repr__()
      • NepseError.to_dict()
    • NepseClientError
      • NepseClientError.__init__()
    • NepseAuthenticationError
      • NepseAuthenticationError.__init__()
    • NepseBadGatewayError
      • NepseBadGatewayError.__init__()
    • NepseServerError
      • NepseServerError.__init__()
    • NepseNetworkError
      • NepseNetworkError.__init__()
    • NepseValidationError
      • NepseValidationError.__init__()
    • NepseRateLimitError
      • NepseRateLimitError.retry_after
      • NepseRateLimitError.__init__()
    • NepseDataNotFoundError
      • NepseDataNotFoundError.__init__()
    • NepseTimeoutError
      • NepseTimeoutError.timeout
      • NepseTimeoutError.__init__()
    • NepseConnectionError
      • NepseConnectionError.__init__()
    • NepseConfigurationError
      • NepseConfigurationError.__init__()
    • get_exception_for_status()
    • Exception Hierarchy
    • Base Exception
      • NepseError
        • NepseError
    • Client Errors
      • NepseClientError
        • NepseClientError
      • NepseValidationError
        • NepseValidationError
    • Authentication Errors
      • NepseAuthenticationError
        • NepseAuthenticationError
    • Server Errors
      • NepseServerError
        • NepseServerError
      • NepseBadGatewayError
        • NepseBadGatewayError
    • Network Errors
      • NepseNetworkError
        • NepseNetworkError
      • NepseConnectionError
        • NepseConnectionError
      • NepseTimeoutError
        • NepseTimeoutError
    • Rate Limiting
      • NepseRateLimitError
        • NepseRateLimitError
    • Data Errors
      • NepseDataNotFoundError
        • NepseDataNotFoundError
    • Configuration Errors
      • NepseConfigurationError
        • NepseConfigurationError
    • Error Handling Best Practices
      • Catch Specific Exceptions
      • Retry Logic
      • Logging Errors
      • Graceful Degradation

Additional Information

  • Important Disclaimers
    • Unofficial Library
    • Financial Disclaimer
    • Liability Disclaimer
    • Data Accuracy
    • User Responsibilities
      • Legal Compliance
      • Prohibited Uses
      • Responsible Use
    • Security Warnings
    • Trademark Notice
    • No Warranty
    • Support & Contact
    • Acceptance of Terms
    • Final Warning
    • Questions?
  • Changelog
    • [Unreleased]
    • [1.0.0] - 2024-01-15
      • Added
    • [0.9.0] - 2024-01-10 [BETA]
      • Added
      • Changed
      • Fixed
    • [0.5.0] - 2024-01-05 [ALPHA]
      • Added
      • Known Issues
    • Migration Guides
      • Migrating to 1.0.0 from 0.x
    • Deprecation Warnings
    • Version History
    • Support Policy
    • Contributing
    • Release Process
      • Semantic Versioning
    • Links
  • Contributing Guide
    • Getting Started
    • Development Workflow
      • Making Changes
    • Code Standards
      • Style Guidelines
      • Testing
      • Documentation
    • Pull Request Process
    • Reporting Issues
      • Bug Reports
      • Feature Requests
    • Code of Conduct
    • Questions?
  • License
    • Official NEPSE Resources
    • MIT License
    • What This Means
      • You can:
      • You must:
      • You cannot:
    • Responsible Use
    • Liability Disclaimer
    • Data Source Disclaimer
    • Trademark Notice
    • Dependencies
      • httpx
      • pywasm
      • tqdm
    • Security Considerations
    • Reporting Issues
    • Legal Compliance
    • Updates and Changes
    • Contact Information
    • Questions?
    • Full License Text
NEPSE Client
  • Overview: module code

All modules for which code is available

  • nepse-client
  • nepse_client.async_client
  • nepse_client.client
  • nepse_client.dummy_id_manager
  • nepse_client.exceptions
  • nepse_client.sync_client
  • nepse_client.token_manager

© Copyright 2025, Amrit Giri.

Built with Sphinx using a theme provided by Read the Docs.