{"id":15144247,"url":"https://github.com/ankitz007/mf-nav-api","last_synced_at":"2026-01-20T01:59:45.034Z","repository":{"id":256056031,"uuid":"854225810","full_name":"Ankitz007/mf-nav-api","owner":"Ankitz007","description":"This Go-based backend service provides access to information about Indian mutual funds and their Net Asset Values (NAV). Given a mutual fund ID, you can retrieve the latest NAV details or filter NAV data within a specified date range","archived":false,"fork":false,"pushed_at":"2024-09-15T10:43:06.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-12T22:47:45.269Z","etag":null,"topics":["api","golang","learning-by-doing","vercel","vercel-serverless"],"latest_commit_sha":null,"homepage":"https://mf-nav-api.vercel.app","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Ankitz007.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-08T17:52:07.000Z","updated_at":"2024-09-15T10:43:09.000Z","dependencies_parsed_at":"2024-12-20T04:08:35.600Z","dependency_job_id":"66948771-b20f-426b-862e-0045fc1a397a","html_url":"https://github.com/Ankitz007/mf-nav-api","commit_stats":null,"previous_names":["ankitz007/mf-nav-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ankitz007%2Fmf-nav-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ankitz007%2Fmf-nav-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ankitz007%2Fmf-nav-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ankitz007%2Fmf-nav-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ankitz007","download_url":"https://codeload.github.com/Ankitz007/mf-nav-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247517924,"owners_count":20951716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","golang","learning-by-doing","vercel","vercel-serverless"],"created_at":"2024-09-26T10:23:06.177Z","updated_at":"2026-01-20T01:59:44.989Z","avatar_url":"https://github.com/Ankitz007.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mutual Funds NAV API\n\n\u003e [!NOTE]  \n\u003e This is a learning project and is not intended for any other use. Please use it only for educational purposes.\n\n## Overview\n\nWelcome to the **Mutual Funds NAV API** project! This Go-based backend service provides access to information about Indian mutual funds and their Net Asset Values (NAV). Given a mutual fund ID, you can retrieve the latest NAV details or filter NAV data within a specified date range.\n\n## Features\n\n- **Fetch NAV Information**: Retrieve the NAV details for a specified mutual fund ID.\n- **Date Range Filtering**: Optionally filter NAV data for a mutual fund within a specific date range (format: `dd-mm-yyyy`).\n- **Database Caching**: The system first checks a remote database for the requested data and fetches from an upstream API only if the data is not available remotely.\n\n## How It Works\n\n1. **Database Lookup**: When a request is made, the service first queries the remote database for the required NAV information.\n2. **Upstream API Fetch**: If the data is not found in the remote database, the service fetches it from an upstream API.\n3. **Caching**: New data fetched from the upstream API is saved in the remote database for future requests.\n\n## Getting Started\n\n### Prerequisites\n\n- Docker and Docker Compose\n\n### Local Development with Docker\n\nTo simplify local development and testing, use Docker. The project includes Docker Compose and a Dockerfile configured for hot-reloading with Air. \n\nPlease update your environment variables in a `.env` file using `.env.example` file before proceeding ahead. \n\n1. **Build and Start the Docker Containers**\n\n   ```bash\n   docker-compose up -d mf-nav-api\n   ```\n\n   This command will build the Docker image and start the application in detached mode. The Air tool will automatically reload the service whenever you make changes to the code.\n\n2. **Access the Application**\n\n   The application should now be running and accessible at `http://localhost:8080`. Adjust your `docker-compose.yml` if you need to change the port.\n\n### Usage\n\n#### API Endpoints\n\n- **Get NAV by Mutual Fund ID**\n\n  ```\n  GET /fund/{mutualFundID}\n  ```\n\n  **Parameters:**\n  - `mutualFundID`: The unique ID for the mutual fund.\n\n- **Get NAV by Mutual Fund ID and Date Range**\n\n  ```\n  GET /fund/{mutualFundID}?start={startDate}\u0026end={endDate}\n  ```\n\n  **Parameters:**\n  - `mutualFundID`: The unique ID for the mutual fund.\n  - `startDate`: Start date in `dd-mm-yyyy` format.\n  - `endDate`: End date in `dd-mm-yyyy` format.\n\n## Work in Progress\n\nPlease note that this project is still under development. While the core functionality is operational, there may be incomplete features and potential bugs. I am actively working on enhancements and improvements.\n\n## Contributing\n\nI welcome contributions to improve this project. If you have suggestions or find issues, please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contact\n\nFor questions or further information, please reach out to me or open an issue on the GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitz007%2Fmf-nav-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fankitz007%2Fmf-nav-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fankitz007%2Fmf-nav-api/lists"}