{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5314c0b5-13fa-407c-9d19-65bcdad2ed85","name":"Finance Tracker API","description":"## **Finance Tracker API Documentation**\n\n### **📄 Overview**\n\nThe **Finance Tracker API** is a backend service designed to help users manage their finances efficiently. It provides features for tracking budgets, setting financial goals, monitoring transactions, and receiving real-time notifications. This API is built with **Node.js**, **MongoDB**, and Redis for real-time communication.\n\n👉 [github.com/nmdra/Finance-Tracker-API](https://github.com/nmdra/Finance-Tracker-API)\n\n---\n\n## **🚀 Getting Started Guide**\n\nTo start using the **Finance Tracker API**, follow these steps:\n\n1. **Authentication**\n    \n    - All requests require authentication via a token.\n        \n    - Obtain a token by logging in via `/api/v1/user/auth`.\n        \n    - Include the token in requests using the `Authorization` header as `Bearer` .\n        \n2. **Set Up Your Finances**\n    \n    - Create an account (`POST /api/v1/user`).\n        \n    - Set up your financial **goals** (`POST /api/v1/goals`).\n        \n    - Define a **budget** (`POST /api/v1/budgets`).\n        \n    - Start adding **transactions** (`POST /api/v1/transactions`).\n        \n3. **Track Your Progress**\n    \n    - View your **budget status** (`GET /api/v1/budgets`).\n        \n    - Check your **financial reports** (`GET /api/v1/reports`).\n        \n    - Receive **notifications** for financial alerts (`GET /api/v1/notifications`).\n        \n\n---\n\n## **🔑 Authentication**\n\nThe **Finance Tracker API** uses **JWT (JSON Web Token) authentication** for secure access.\n\n1. **Register a User** → `POST /api/v1/user`\n    \n2. **Login** → `POST /api/v1/user/auth` (returns a JWT token)\n    \n3. **Include the Token in Requests** → Add `Authorization: Bearer` header.\n    \n4. **Logout** → `POST /api/v1/user/logout`\n    \n\n📌 **Authentication Error Response**\n\nIf an API request is made without a valid token, the response will be:\n\n``` json\n{\n  \"message\": \"Unauthorized\"\n}\n\n ```\n\nHTTP Status Code: **401 Unauthorized**\n\n---\n\n## **📊 Key Features**\n\n### **🔹 Budget Management**\n\n- Create, update, and track budgets.\n    \n- Set spending limits for categories.\n    \n- Monitor available budget in real time.\n    \n\n### **🔹 Financial Goals & Savings**\n\n- Set and track progress on financial goals.\n    \n- Automate savings allocation.\n    \n- Receive alerts when nearing or reaching a goal.\n    \n\n### **🔹 Transactions Tracking**\n\n- Log income and expenses.\n    \n- Categorize transactions for better insights.\n    \n- Generate financial reports on spending trends.\n    \n\n### **🔹 Notifications & Alerts**\n\n- Get real-time alerts for unusual spending patterns.\n    \n- Receive reminders for bill payments and upcoming financial goals.\n    \n- Mark notifications as read.\n    \n\n### **🔹 HATEOAS-Enabled Responses**\n\nresponses include **HATEOAS (Hypermedia as the Engine of Application State)** links to make API navigation easier.\n\nExample for `/api/v1/user/profile`:\n\n``` json\n{\n    \"user\": {\n        \"_id\": \"12345\",\n        \"firstname\": \"John\",\n        \"lastname\": \"Doe\",\n        \"email\": \"john.doe@example.com\"\n    },\n    \"links\": {\n        \"transactions\": {\n            \"href\": \"/api/v1/transactions/user/12345\",\n            \"method\": \"GET\"\n        },\n        \"notifications\": {\n            \"href\": \"/api/v1/notifications/user/12345\",\n            \"method\": \"GET\"\n        },\n        \"goals\": {\n            \"href\": \"/api/v1/goals/user/12345\",\n            \"method\": \"GET\"\n        },\n        \"budgets\": {\n            \"href\": \"/api/v1/budgets/user/12345\",\n            \"method\": \"GET\"\n        }\n    }\n}\n\n ```\n\n---\n\n## **📈 Rate and Usage Limits**\n\nTo ensure fair usage, the API has the following rate limits:\n\n- **300 requests per minute** per API key.\n    \n- If limits are exceeded, requests will return an HTTP `429 Too Many Requests` status.\n    \n\nEach response includes headers:\n\n| Header | Description |\n| --- | --- |\n| `X-RateLimit-Limit` | Maximum allowed requests per minute. |\n| `X-RateLimit-Remaining` | Number of requests left in the current window. |\n| `X-RateLimit-Reset` | Time until the rate limit resets (in UTC epoch). |\n\nIf an unexpected spike in traffic occurs, you may receive a **503 Service Unavailable** error.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33227780","collectionId":"5314c0b5-13fa-407c-9d19-65bcdad2ed85","publishedId":"2sAYdoF7xS","public":true,"publicUrl":"https://documenter-api.postman.tech/view/33227780/2sAYdoF7xS","privateUrl":"https://go.postman.co/documentation/33227780-5314c0b5-13fa-407c-9d19-65bcdad2ed85","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-03-08T18:57:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"New Environment","id":"d1bc18b2-6507-48d6-9082-b862da4a829b","owner":"33227780","values":[{"key":"baseurl","value":"localhost:5001","enabled":true,"type":"default"},{"key":"created_id","value":"","enabled":true,"type":"any"},{"key":"requestPayload","value":"","enabled":true,"type":"any"},{"key":"userId","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"New Environment","value":"33227780-d1bc18b2-6507-48d6-9082-b862da4a829b"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYdoF7xS"}