improve wording

This commit is contained in:
Nemo 2021-05-20 23:11:33 +05:30
parent b00ba8c2eb
commit 4293d9d0b9
2 changed files with 9 additions and 4 deletions

View File

@ -2,9 +2,9 @@
tags: [introduction]
---
# README
# Kuvera Unofficial API Specification
Welcome to the unofficial Kuvera API docs. Kuvera has a pretty good read-only API that has CORS enabled for all domains. As an example, you can find a demo of the complete NIFTY 50 graph generated here.
Welcome to the unofficial Kuvera API docs. Kuvera has a decent good read-only API that this project documents.
## Data Available:
@ -25,4 +25,8 @@ CORS is enabled for all requests across all domains, so you don't need to proxy
## Disclaimer
I've documented this for educational purposes, because I wanted a way to get the latest NAV of my Mutual Funds in a script. If you use this for any purpose, it is at your own liability. If Kuvera makes any changes, this may break - I don't give any guarantees.
I've documented this for educational purposes, because I wanted a way to get the latest NAV of my Mutual Funds in a script. If you use this for any purpose, it is at your own liability. If Kuvera makes any changes, this may break - I don't give any guarantees. This is a read only API, so you can't use this to manage your funds.
## Stoplight
The API was documented using Stoplight Studio, and is hosted on the stoplight website.

View File

@ -160,7 +160,7 @@ paths:
tags:
- Top Funds
parameters: []
/v3/funds/tags/top_watchlist.json:
/api/v3/funds/tags/top_watchlist.json:
get:
summary: Top Watched Funds
responses:
@ -176,6 +176,7 @@ paths:
description: List of top watched Mutual Funds
tags:
- Top Funds
parameters: []
/api/v3/funds/index_nav/NIFTY50.json:
get:
summary: NIFTY 50 Historical Value