https://github.com/losparviero/upauth
Authentication management solution for Upstox's Uplink API.
https://github.com/losparviero/upauth
algo algo-trading authentication upstox
Last synced: 8 months ago
JSON representation
Authentication management solution for Upstox's Uplink API.
- Host: GitHub
- URL: https://github.com/losparviero/upauth
- Owner: losparviero
- License: agpl-3.0
- Created: 2024-04-27T09:52:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-06T06:34:00.000Z (over 1 year ago)
- Last Synced: 2025-02-12T17:17:20.535Z (8 months ago)
- Topics: algo, algo-trading, authentication, upstox
- Language: JavaScript
- Homepage: https://npmjs.com/uxauth
- Size: 22.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Upauth
Authentication management solution for Upstox's Uplink API.
You only have to implement it in your code, it takes care of caching and reusing the access token.
The token is persisted throughout in the .env till it expires.
### Usage
```js
import performAuth from "upauth";
const accessToken = await performAuth();
```
### Install
```
npm i uxauth
```
Make sure your .env has the following variables and your redirect_uri is set to the one below on Upstox.
CLIENT_ID = "your client_id"
CLIENT_SECRET = "your client_secret"
REDIRECT_URI = http://localhost:3000/redirect
Refer to Upstox documentation for the same.
### License
AGPL-3.0 ©️ Zubin