Git Product home page Git Product logo

zerodha_api's Introduction

zerodha_api

Python Version Django Version Redis Server

Running the Project Locally

First, clone the repository to your local machine:

git clone https://github.com/amity29/zerodha_api.git

Install the requirements:

pip install -r requirements.txt

Create .env file in the settings.py directory

Set up following environment variable:

    SECRET_KEY =
    DEBUG =
    URL =
    REDIS_HOST =
    REDIS_PORT =
    REDIS_PASSWORD =
    CHROMEDRIVER_PATH =

Finally, run the development server:

python manage.py runserver

The API endpoints will be available at 127.0.0.1:8000 by default.

API endpoints details

Scrape data

    http://{server}:{port}/scrape

This endpoint will start the Scrapping in the background using thread and store the data in redis db. You can also run the scraping for a specific date by providing a optional query parameter date with the url

    http://{server}:{port}/scrape?date={YYYY-MM-DD}

List Result

    http://{server}:{port}/list

This endpoint will serve the data stored in redis db in the JSON format. You can also search for a specific name by providing a optional query parameter search with the url

    http://{server}:{port}/list?search={name}

Delete Data

    http://{server}:{port}/delete

This endpoint will delete all the scraped data from redis db.

zerodha_api's People

Contributors

amity29 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.