kuvera-unofficial-api-speci.../docs/introduction/Kuvera-Unofficial-API-Docum...

39 lines
1.4 KiB
Markdown
Raw Normal View History

2021-05-20 17:11:29 +00:00
---
tags: [introduction]
---
2021-05-20 17:41:33 +00:00
# Kuvera Unofficial API Specification
2021-05-20 17:11:29 +00:00
2021-05-20 17:41:33 +00:00
Welcome to the unofficial Kuvera API docs. Kuvera has a decent good read-only API that this project documents.
2021-05-20 17:11:29 +00:00
2021-05-27 06:58:46 +00:00
2021-05-20 17:11:29 +00:00
## Data Available:
1. NIFTY50 Historical Value
2. List of AMCs
3. List of Mutual Fund Plans
4. Categories of Mutual Funds, along with returns for various time ranges.
2021-05-20 18:46:04 +00:00
5. Details about a specific Mutual Fund Plan(s)
2021-05-20 17:11:29 +00:00
6. Top bought, sold, and watched funds on Kuvera
2021-05-20 18:46:04 +00:00
7. Fixed Deposit Plans
8. Crypto Tokens (in INR)
2021-05-21 06:24:05 +00:00
9. Gold rates, both hisorical and latest
10. Exchange rate for USD
2021-05-21 06:39:23 +00:00
11. User Profile information
2021-05-20 17:11:29 +00:00
## Authentication
2021-06-03 16:26:23 +00:00
Most APIs don't need any authentication. APIs that require authentication are marked with a `[A]`.
2021-05-20 17:11:29 +00:00
## CORS
CORS is enabled for all requests across all domains, so you don't need to proxy any requests. You can directly build your static site using this API.
## Disclaimer
2021-05-20 17:41:33 +00:00
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
2021-05-20 17:45:55 +00:00
The API was documented using Stoplight Studio, and is hosted on the stoplight website. The API is documented using OpenAPI v3 in the `Kuvera.yaml` file. The source code can be found at https://github.com/captn3m0/kuvera-unofficial-api-specification