Skip to main content

A wrapper around fyers_apiv3 to make it easier to use

Project description

badge1 badge2 badge3

Why Fryers?

The reason i created this wrapper module for the fyers_apiv3 module provided by the Fyers platform is because one has to make sure the access token is valid and if not generate new access token or use refresh_token, which added overhead to the scripts created using this module. But my wrapper takes care of all that.

We Just have to provide my wrapper class Fyers with the client_id, secret_key and the pin. Once thats given, the login flow will be taken care of and we can enjoy the scripting without any hassel.

How to Install

pip install fryers

Simple way to use

We can use this module for login flow and then use the native fyersModel instance to interact with the API.

Simple code to do this would be

from fryers import Fyers

client_id = "xxxxx"
secret_key = "xxyyxyxy"
pin = "4783"

# Fyers logins automatically uses a saved token, if exists
# otherwise it re-initiates the login flow
# it outputs the returned URL which user has to visit
# and then copy the auth_code from there and paste it in the terminal
fyers = Fyers(client_id, secret_key, pin=pin)    # creates a file tokens.txt where tokens are stored

# grab the native instance and use native api
native_fyers = fyers.get_native_instance()

# we can use native api from (native_fyers) which is an instance of FyersModel

NOTE

This is current in development, i will be adding more features to make the api easy to use. I will also create a comprehensive documentation for this wrapper so that users dont have an issue using it.

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

fryers-1.0.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

fryers-1.0.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file fryers-1.0.0.tar.gz.

File metadata

  • Download URL: fryers-1.0.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for fryers-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9d8849ae38673a8733bf4b4e48c5c65ff616104bfec153dfe64bcf61dc145589
MD5 d512932132c5ce1d098747725a105126
BLAKE2b-256 46781a167b9f22d3ada459b0762033207390bd673ab26820353e5558eaf6c046

See more details on using hashes here.

File details

Details for the file fryers-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: fryers-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for fryers-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17531dcd99be673a5a04ebcf4cecfee4ca9a72e0bc13310bc353bf4a07008f44
MD5 7855e187ec4cc486ec00730ca7ec2bb0
BLAKE2b-256 19b82091da14847f3fc8c63085bf7983c06659117263a69720987036a3451f33

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