Skip to main content

This is a API wrapper for NEPSE API.

Project description

NEPSE API Wrapper

This python module fetches the data from Nepali Stock Site and provides them in a pythonic and usable way.

About

This is a API wrapper for NEPSE API. This project was inspired from PyPi Nepse.

Documentation

There is a detailed guide in my documentation page for getting started and installing. Documentation

How to use?

You can use this by package from Nepse API PyPi

pip install nepse-api

Why use this?

How is this better than PyPi Nepse?

  • It is asynchronous.
  • Data can be taken as attributes rather than from dict.
  • Data is fetched from the API rather than scraping the site.
  • Data is cached

APIs used

The APIs that I used to create this API wrapper is:

How to use?

import asyncio
import httpx
from nepse import Client


async def main():
    company_Symbol = input('Input Company Symbol (Uppercase): ')

    # Doing this is optional you can directly
    # Initialize using `client = Client()` as well
    async with httpx.AsyncClient() as async_client:
        # Initializes the client
        client = Client(httpx_client=async_client)

        # Gets the data
        data = await client.security_client.get_company(symbol=f"{company_Symbol}")

        # Prints the highest price for that company today
        print(f'High Price of {company_Symbol}: ', data.high_price)
        print(f'Low price of {company_Symbol}: ', data.low_price)
        print(f'Open Price of {company_Symbol}: ', data.open_price)

# Run the function
loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Why are the attributes so in-costistent?

The attribues are in-consistent because the attributes are set according to the response set by the API. I tried changing it up but that would be distruptive because the comability with the API would be broken.

Want To Contribute?

You can send a pull request or open an issue to contribute. Check out Code Of Conduct before contributing.

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

nepse-api-1.1.10.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

nepse_api-1.1.10-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file nepse-api-1.1.10.tar.gz.

File metadata

  • Download URL: nepse-api-1.1.10.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.14-arch1-1

File hashes

Hashes for nepse-api-1.1.10.tar.gz
Algorithm Hash digest
SHA256 785a7d52a6a9f39129b674d753e73f79114f7aa6e936993b4f20b2b79a72c34e
MD5 bf054c476a5178d35b2e2c308405d668
BLAKE2b-256 384a1ab3956a388d6fef92bcd6fbb86100b86a1e901e2b23f51a669653673ff8

See more details on using hashes here.

File details

Details for the file nepse_api-1.1.10-py3-none-any.whl.

File metadata

  • Download URL: nepse_api-1.1.10-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.12.14-arch1-1

File hashes

Hashes for nepse_api-1.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 066a904d5913f6b06f8a2a4b6c0b21db11b9ec89f420d4ef674aab886cb5cd91
MD5 676781a68bae0a391175849556271c2e
BLAKE2b-256 19cea3db30b6044563694db1b4d39c691554a43390f3962f78c0a4fd6cf31d4b

See more details on using hashes here.

Supported by

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