{ "info": { "_postman_id": "aacf3c6c-851b-4020-95a2-77f9092bd06e", "name": "SetuGeo API - Demo & Sales Collection", "description": "Generated on 2026-10-17 20:15:30 from the current Laravel route catalog.\n\nUse this collection for product demos, sales walkthroughs, and production smoke checks. The token request saves the bearer token automatically for the rest of the collection.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.collectionVariables.set(\"lastStatusCode\", String(pm.response.code));" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://setugeo.com/api/v1", "type": "string" }, { "key": "localBaseUrl", "value": "http://127.0.0.1:8000/api/v1", "type": "string" }, { "key": "clientKey", "value": "YOUR_CLIENT_KEY", "type": "string" }, { "key": "clientSecret", "value": "YOUR_CLIENT_SECRET", "type": "string" }, { "key": "bearerToken", "value": "YOUR_TOKEN_HERE", "type": "string" }, { "key": "marketDate", "value": "", "type": "string", "description": "Optional market date in YYYY-MM-DD format. Leave blank to use the latest available data." }, { "key": "lastStatusCode", "value": "", "type": "string" } ], "item": [ { "name": "00. Getting Started", "description": "Authenticate first, then use the bearer token automatically across the collection.", "item": [ { "name": "Generate Bearer Token", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "client_key", "value": "{{clientKey}}", "type": "text" }, { "key": "client_secret", "value": "{{clientSecret}}", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/auth/token", "host": [ "{{baseUrl}}" ], "path": [ "auth", "token" ] }, "description": "Exchange client credentials for a bearer token. The test script stores the token automatically." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const jsonData = pm.response.json();", "const token = jsonData?.data?.access_token;", "if (token) {", " pm.collectionVariables.set(\"bearerToken\", token);", " pm.environment.set(\"bearerToken\", token);", "}" ] } } ], "response": [ { "name": "Token Generated", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Token generated successfully\",\n \"data\": {\n \"access_token\": \"1|sample-token\",\n \"token_type\": \"Bearer\"\n }\n}" }, { "name": "Validation Failed", "status": "Unprocessable Entity", "code": 422, "_postman_previewlanguage": "json", "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"client_key\": [\n \"The client key field is required.\"\n ],\n \"client_secret\": [\n \"The client secret field is required.\"\n ]\n }\n}" }, { "name": "Invalid Credentials", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Invalid API credentials\",\n \"data\": null\n}" }, { "name": "Inactive Account", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Account is inactive. Please contact support.\",\n \"data\": null\n}" } ] }, { "name": "Check OCR Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ocr/health", "host": [ "{{baseUrl}}" ], "path": [ "ocr", "health" ] }, "description": "Quick unauthenticated health check for the OCR service." }, "response": [ { "name": "OCR Healthy", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"OCR service is healthy.\",\n \"data\": {\n \"status\": \"up\"\n }\n}" }, { "name": "OCR Service Error", "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"OCR service is currently unavailable.\",\n \"data\": null\n}" } ] } ] }, { "name": "01. Geography & Address", "description": "Country, state, city, pincode, timezone, address, and geospatial APIs.", "item": [ { "name": "Address", "item": [ { "name": "Validate Address by Pincode", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/address/validate", "host": [ "{{baseUrl}}" ], "path": [ "address", "validate" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/address/validate\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Autocomplete Address", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/address/autocomplete?q=delhi", "host": [ "{{baseUrl}}" ], "path": [ "address", "autocomplete" ], "query": [ { "key": "q", "value": "delhi" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/address/autocomplete\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Cities", "item": [ { "name": "List Cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cities?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "cities" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/cities\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Countries", "item": [ { "name": "Get Country Tax Data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/tax-data", "host": [ "{{baseUrl}}" ], "path": [ "countries", "tax-data" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/countries/tax-data\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Country Economic Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/economic-profile?sort_by=gdp", "host": [ "{{baseUrl}}" ], "path": [ "countries", "economic-profile" ], "query": [ { "key": "sort_by", "value": "gdp" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/countries/economic-profile\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Country Analysis: Regional Gdp", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/analysis/regional-gdp", "host": [ "{{baseUrl}}" ], "path": [ "countries", "analysis", "regional-gdp" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/countries/analysis/regional-gdp\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Country Compare", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/compare", "host": [ "{{baseUrl}}" ], "path": [ "countries", "compare" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/countries/compare\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "List Countries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "countries" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/countries\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Geospatial", "item": [ { "name": "Get Geospatial Statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geospatial/statistics", "host": [ "{{baseUrl}}" ], "path": [ "geospatial", "statistics" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/geospatial/statistics\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Find Nearby Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geospatial/nearby?lat=28.6139&lng=77.209&radius=25&type=city&limit=3", "host": [ "{{baseUrl}}" ], "path": [ "geospatial", "nearby" ], "query": [ { "key": "lat", "value": "28.6139" }, { "key": "lng", "value": "77.209" }, { "key": "radius", "value": "25" }, { "key": "type", "value": "city" }, { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/geospatial/nearby\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Reverse Geocode Coordinates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geospatial/geocode?lat=28.6139&lng=77.209", "host": [ "{{baseUrl}}" ], "path": [ "geospatial", "geocode" ], "query": [ { "key": "lat", "value": "28.6139" }, { "key": "lng", "value": "77.209" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/geospatial/geocode\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Calculate Distance Between Coordinates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geospatial/distance?lat1=28.6139&lng1=77.209&lat2=28.7139&lng2=77.309&unit=km", "host": [ "{{baseUrl}}" ], "path": [ "geospatial", "distance" ], "query": [ { "key": "lat1", "value": "28.6139" }, { "key": "lng1", "value": "77.209" }, { "key": "lat2", "value": "28.7139" }, { "key": "lng2", "value": "77.309" }, { "key": "unit", "value": "km" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/geospatial/distance\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Cluster Nearby Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geospatial/cluster?lat=28.6139&lng=77.209&radius=25&grid_size=0.5", "host": [ "{{baseUrl}}" ], "path": [ "geospatial", "cluster" ], "query": [ { "key": "lat", "value": "28.6139" }, { "key": "lng", "value": "77.209" }, { "key": "radius", "value": "25" }, { "key": "grid_size", "value": "0.5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/geospatial/cluster\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Find Locations in Boundary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geospatial/boundary?min_lat=28.1139&max_lat=29.2139&min_lng=76.709&max_lng=77.809&type=city&limit=3", "host": [ "{{baseUrl}}" ], "path": [ "geospatial", "boundary" ], "query": [ { "key": "min_lat", "value": "28.1139" }, { "key": "max_lat", "value": "29.2139" }, { "key": "min_lng", "value": "76.709" }, { "key": "max_lng", "value": "77.809" }, { "key": "type", "value": "city" }, { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/geospatial/boundary\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Pincodes", "item": [ { "name": "Search Pincodes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pincodes/search", "host": [ "{{baseUrl}}" ], "path": [ "pincodes", "search" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/pincodes/search\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "List Pincodes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pincodes?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "pincodes" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/pincodes\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Regions", "item": [ { "name": "List Regions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/regions?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "regions" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/regions\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "States", "item": [ { "name": "List States", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/states?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "states" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/states\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Sub-Regions", "item": [ { "name": "List Sub Regions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub-regions?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "sub-regions" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/sub-regions\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Timezones", "item": [ { "name": "List Timezones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/timezones?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "timezones" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/timezones\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Timezone Convert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/timezones/convert?datetime=2026-10-17+20%3A15%3A29&from=UTC&to=Asia%2FKolkata", "host": [ "{{baseUrl}}" ], "path": [ "timezones", "convert" ], "query": [ { "key": "datetime", "value": "2026-10-17 20:15:29" }, { "key": "from", "value": "UTC" }, { "key": "to", "value": "Asia/Kolkata" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/timezones/convert\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Timezone Convert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/timezone/convert?datetime=2026-10-17+20%3A15%3A29&from=UTC&to=Asia%2FKolkata", "host": [ "{{baseUrl}}" ], "path": [ "timezone", "convert" ], "query": [ { "key": "datetime", "value": "2026-10-17 20:15:29" }, { "key": "from", "value": "UTC" }, { "key": "to", "value": "Asia/Kolkata" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/timezone/convert\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "02. Banking & Currency", "description": "Bank coverage, branch lookup, and currency conversion APIs.", "item": [ { "name": "Banks", "item": [ { "name": "Search Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branch/search?q=main&limit=3", "host": [ "{{baseUrl}}" ], "path": [ "branch", "search" ], "query": [ { "key": "q", "value": "main" }, { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/branch/search\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "List Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/banks?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "banks" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/banks\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Bank Digital Coverage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/banks/digital-coverage?limit=3", "host": [ "{{baseUrl}}" ], "path": [ "banks", "digital-coverage" ], "query": [ { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/banks/digital-coverage\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Bank: Branches Search", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank/branches/search?q=main&limit=3", "host": [ "{{baseUrl}}" ], "path": [ "bank", "branches", "search" ], "query": [ { "key": "q", "value": "main" }, { "key": "limit", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/bank/branches/search\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Currency", "item": [ { "name": "Get Currency Exchange", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/currency/exchange?currency=USD", "host": [ "{{baseUrl}}" ], "path": [ "currency", "exchange" ], "query": [ { "key": "currency", "value": "USD" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/currency/exchange\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Convert Currency", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/currency/convert?from=USD&to=USD&amount=10", "host": [ "{{baseUrl}}" ], "path": [ "currency", "convert" ], "query": [ { "key": "from", "value": "USD" }, { "key": "to", "value": "USD" }, { "key": "amount", "value": "10" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/currency/convert\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "03. Market Data", "description": "Equities, indices, mutual funds, and market overview APIs.", "item": [ { "name": "Equities", "item": [ { "name": "Equity Analysis: Top Turnover", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/top-turnover?exchange=nse", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "top-turnover" ], "query": [ { "key": "exchange", "value": "nse" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/top-turnover\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Wide Range Stocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/wide-range-stocks?exchange=nse&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "wide-range-stocks" ], "query": [ { "key": "exchange", "value": "nse" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/wide-range-stocks\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity OHLC Data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/ohlc", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "ohlc" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/ohlc\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: 52 Week Extremes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/52-week-extremes?type=high&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "52-week-extremes" ], "query": [ { "key": "type", "value": "high" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/52-week-extremes\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity Compare Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/compare-index?index_code=BHARATBOND-APR30&period=1y", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "compare-index" ], "query": [ { "key": "index_code", "value": "BHARATBOND-APR30" }, { "key": "period", "value": "1y" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/compare-index\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/history", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "history" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/history\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Market Cap Stats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/market-cap-stats", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "market-cap-stats" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/market-cap-stats\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163?date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163" ], "query": [ { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-12\",\n \"data\": {\n \"isin\": \"INE002A01018\",\n \"company_name\": \"RELIANCE INDUSTRIES LTD\",\n \"short_name\": \"Reliance\",\n \"nse_symbol\": \"RELIANCE\",\n \"bse_symbol\": \"500325\",\n \"series\": \"EQ\",\n \"security_type\": \"NORMAL\",\n \"industry\": \"Oil & Gas\",\n \"market_lot\": 1,\n \"qty_multiplier\": 1,\n \"mtf_enabled\": true,\n \"mtf_bracket\": 26.5,\n \"cas_eligible\": true,\n \"intraday_margin\": 20,\n \"intraday_leverage\": 5,\n \"nse_tick_size\": 5,\n \"bse_tick_size\": 5,\n \"nse_freeze_quantity\": 100000,\n \"bse_freeze_quantity\": null,\n \"price\": {\n \"traded_date\": \"2026-10-12\",\n \"nse_close\": \"3012.7500\",\n \"nse_chg_1d\": \"4.2500\",\n \"nse_volume\": 1250000\n },\n \"price_history\": [\n {\n \"traded_date\": \"2026-06-12\",\n \"nse_open\": \"2860.00\",\n \"nse_high\": \"2895.50\",\n \"nse_low\": \"2848.25\",\n \"nse_close\": \"2884.75\",\n \"nse_prev_close\": \"2856.10\",\n \"nse_volume\": 1150000,\n \"bse_open\": \"2859.80\",\n \"bse_high\": \"2895.25\",\n \"bse_low\": \"2848.00\",\n \"bse_close\": \"2884.60\",\n \"bse_prev_close\": \"2855.90\",\n \"bse_volume\": 165000\n }\n ]\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: High Volume", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/high-volume?exchange=nse", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "high-volume" ], "query": [ { "key": "exchange", "value": "nse" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/high-volume\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Intraday Movers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/intraday-movers?exchange=nse&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "intraday-movers" ], "query": [ { "key": "exchange", "value": "nse" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/intraday-movers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: High Activity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/high-activity?exchange=nse&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "high-activity" ], "query": [ { "key": "exchange", "value": "nse" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/high-activity\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Gap Movers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/gap-movers?exchange=nse&direction=up&min_pct=1&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "gap-movers" ], "query": [ { "key": "exchange", "value": "nse" }, { "key": "direction", "value": "up" }, { "key": "min_pct", "value": "1" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/gap-movers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Consistent Performers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/consistent-performers?period=1m&min_return=1&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "consistent-performers" ], "query": [ { "key": "period", "value": "1m" }, { "key": "min_return", "value": "1" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/consistent-performers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Filter Equities by Market Cap", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/filter/market-cap/large-cap", "host": [ "{{baseUrl}}" ], "path": [ "equities", "filter", "market-cap", "large-cap" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/filter/market-cap/{cap}\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: New Listings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/new-listings", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "new-listings" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/new-listings\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Search Equities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/search?q=749RJ35", "host": [ "{{baseUrl}}" ], "path": [ "equities", "search" ], "query": [ { "key": "q", "value": "749RJ35" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/search\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Nse Bse Spread", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/nse-bse-spread?exchange=nse&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "nse-bse-spread" ], "query": [ { "key": "exchange", "value": "nse" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/nse-bse-spread\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity Activity Metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/activity-metrics?exchange=nse", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "activity-metrics" ], "query": [ { "key": "exchange", "value": "nse" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/activity-metrics\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Sector Heatmap", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/sector-heatmap?period=1m", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "sector-heatmap" ], "query": [ { "key": "period", "value": "1m" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/sector-heatmap\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity Dual Exchange Data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/dual-exchange", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "dual-exchange" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/dual-exchange\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Top Gainers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/top-gainers?exchange=nse", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "top-gainers" ], "query": [ { "key": "exchange", "value": "nse" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/top-gainers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity Metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/metrics", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "metrics" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/metrics\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Equity Analysis: Top Losers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities/analysis/top-losers?exchange=nse", "host": [ "{{baseUrl}}" ], "path": [ "equities", "analysis", "top-losers" ], "query": [ { "key": "exchange", "value": "nse" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equities/analysis/top-losers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Equity Peers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equity/IN2920250163/peers", "host": [ "{{baseUrl}}" ], "path": [ "equity", "IN2920250163", "peers" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/equity/{isin}/peers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "List Equities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/equities?symbol=749RJ35", "host": [ "{{baseUrl}}" ], "path": [ "equities" ], "query": [ { "key": "symbol", "value": "749RJ35" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"data\": {\n \"current_page\": 1,\n \"data\": [\n {\n \"isin\": \"INE002A01018\",\n \"company_name\": \"RELIANCE INDUSTRIES LTD\",\n \"short_name\": \"Reliance\",\n \"nse_symbol\": \"RELIANCE\",\n \"bse_symbol\": \"500325\",\n \"series\": \"EQ\",\n \"security_type\": \"NORMAL\",\n \"industry\": \"Oil & Gas\",\n \"market_lot\": 1,\n \"qty_multiplier\": 1,\n \"mtf_enabled\": true,\n \"mtf_bracket\": 26.5,\n \"cas_eligible\": true,\n \"intraday_margin\": 20,\n \"intraday_leverage\": 5,\n \"nse_tick_size\": 5,\n \"bse_tick_size\": 5,\n \"nse_freeze_quantity\": 100000,\n \"bse_freeze_quantity\": null\n }\n ],\n \"per_page\": 100,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Indices", "item": [ { "name": "Get Index Valuation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/BHARATBOND-APR30/valuation", "host": [ "{{baseUrl}}" ], "path": [ "indices", "BHARATBOND-APR30", "valuation" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/{index_code}/valuation\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Index Valuation History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/BHARATBOND-APR30/valuation-history?months=3", "host": [ "{{baseUrl}}" ], "path": [ "indices", "BHARATBOND-APR30", "valuation-history" ], "query": [ { "key": "months", "value": "3" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/{index_code}/valuation-history\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Index History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/BHARATBOND-APR30/history?start_date=2026-09-17&end_date=2026-10-17", "host": [ "{{baseUrl}}" ], "path": [ "indices", "BHARATBOND-APR30", "history" ], "query": [ { "key": "start_date", "value": "2026-09-17" }, { "key": "end_date", "value": "2026-10-17" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/{index_code}/history\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Index Metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/BHARATBOND-APR30/metrics", "host": [ "{{baseUrl}}" ], "path": [ "indices", "BHARATBOND-APR30", "metrics" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/{index_code}/metrics\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Search Indices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/search?q=BHARATBOND-APR30", "host": [ "{{baseUrl}}" ], "path": [ "indices", "search" ], "query": [ { "key": "q", "value": "BHARATBOND-APR30" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/search\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Index Snapshot", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/snapshot?exchange=NSE", "host": [ "{{baseUrl}}" ], "path": [ "indices", "snapshot" ], "query": [ { "key": "exchange", "value": "NSE" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/snapshot\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Index Holdings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/holdings?index_code=BHARATBOND-APR30", "host": [ "{{baseUrl}}" ], "path": [ "indices", "holdings" ], "query": [ { "key": "index_code", "value": "BHARATBOND-APR30" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/holdings\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Index Analysis: Valuation Comparison", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/analysis/valuation-comparison?exchange=NSE", "host": [ "{{baseUrl}}" ], "path": [ "indices", "analysis", "valuation-comparison" ], "query": [ { "key": "exchange", "value": "NSE" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/analysis/valuation-comparison\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Index Analysis: Top Losers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/analysis/top-losers?period=1d&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "indices", "analysis", "top-losers" ], "query": [ { "key": "period", "value": "1d" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/analysis/top-losers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Index Analysis: Top Gainers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/analysis/top-gainers?period=1d&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "indices", "analysis", "top-gainers" ], "query": [ { "key": "period", "value": "1d" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/analysis/top-gainers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Index Analysis: Ohlc Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/indices/analysis/ohlc-summary?exchange=NSE", "host": [ "{{baseUrl}}" ], "path": [ "indices", "analysis", "ohlc-summary" ], "query": [ { "key": "exchange", "value": "NSE" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/indices/analysis/ohlc-summary\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Market", "item": [ { "name": "List Market Mutual Funds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/mf?per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "mf" ], "query": [ { "key": "per_page", "value": "10" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"type\": \"mutual_funds\",\n \"data\": [\n {\n \"isin\": \"INF109K01VQ0\",\n \"scheme_code\": \"120503\",\n \"scheme_name\": \"Axis Bluechip Fund - Growth\",\n \"amc_name\": \"Axis Mutual Fund\",\n \"category\": \"Equity\",\n \"nav\": 54.32,\n \"nav_date\": \"2026-10-07\",\n \"chg_1d\": 0.42,\n \"chg_1y\": 18.74\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n },\n \"provider\": \"AMFI Official Mutual Fund Feeds with public instrument-data fallback\",\n \"sources\": {\n \"primary\": \"AMFI\",\n \"fallback\": \"Public mutual-fund instrument data\"\n }\n}" } ] }, { "name": "List Market Mutual Funds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/mutual-funds?per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "mutual-funds" ], "query": [ { "key": "per_page", "value": "10" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"type\": \"mutual_funds\",\n \"data\": [\n {\n \"isin\": \"INF109K01VQ0\",\n \"scheme_code\": \"120503\",\n \"scheme_name\": \"Axis Bluechip Fund - Growth\",\n \"amc_name\": \"Axis Mutual Fund\",\n \"category\": \"Equity\",\n \"nav\": 54.32,\n \"nav_date\": \"2026-10-07\",\n \"chg_1d\": 0.42,\n \"chg_1y\": 18.74\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n },\n \"provider\": \"AMFI Official Mutual Fund Feeds with public instrument-data fallback\",\n \"sources\": {\n \"primary\": \"AMFI\",\n \"fallback\": \"Public mutual-fund instrument data\"\n }\n}" } ] }, { "name": "List Nudges by Index", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/nudges/index/BHARATBOND-APR30?per_page=25&date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "nudges", "index", "BHARATBOND-APR30" ], "query": [ { "key": "per_page", "value": "25" }, { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-12\",\n \"index_code\": \"NIFTY_50\",\n \"data\": [\n {\n \"id\": 1,\n \"isin\": null,\n \"exchange\": \"NSE\",\n \"source\": \"index_price\",\n \"category\": \"growth\",\n \"rule\": \"daily_gain\",\n \"severity\": \"info\",\n \"title\": \"NIFTY 50 daily move\",\n \"message\": \"The stock closed 4.25% higher for the day.\",\n \"observed_price\": \"3012.7500\",\n \"metrics\": {\n \"change_percent\": 4.25\n },\n \"trading_date\": \"2026-10-12\",\n \"observed_at\": \"2026-10-12T10:00:00+05:30\",\n \"expires_at\": null,\n \"index_code\": \"NIFTY_50\",\n \"instrument_type\": \"index\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Market Breadth", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/breadth?exchange=nse&period=1d", "host": [ "{{baseUrl}}" ], "path": [ "market", "breadth" ], "query": [ { "key": "exchange", "value": "nse" }, { "key": "period", "value": "1d" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/breadth\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "List Market Stocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/stocks?instrument_type=stocks&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "stocks" ], "query": [ { "key": "instrument_type", "value": "stocks" }, { "key": "per_page", "value": "10" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"type\": \"stocks\",\n \"data\": [\n {\n \"isin\": \"INE002A01018\",\n \"company_name\": \"RELIANCE INDUSTRIES LTD\",\n \"short_name\": \"Reliance\",\n \"nse_symbol\": \"RELIANCE\",\n \"bse_symbol\": \"500325\",\n \"series\": \"EQ\",\n \"security_type\": \"NORMAL\",\n \"industry\": \"Oil & Gas\",\n \"market_lot\": 1,\n \"qty_multiplier\": 1,\n \"mtf_enabled\": true,\n \"mtf_bracket\": 26.5,\n \"cas_eligible\": true,\n \"intraday_margin\": 20,\n \"intraday_leverage\": 5,\n \"live_price\": 1450.25,\n \"change\": 12.25,\n \"change_percent\": 0.85,\n \"tick_size\": {\n \"nse\": 5,\n \"bse\": 5\n },\n \"freeze_quantity\": {\n \"nse\": 100000,\n \"bse\": null\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 10,\n \"total\": 1\n }\n}" } ] }, { "name": "List Similar Stock Nudges by Category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/nudges/category/growth?per_page=25&date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "nudges", "category", "growth" ], "query": [ { "key": "per_page", "value": "25" }, { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-12\",\n \"category\": \"growth\",\n \"data\": [\n {\n \"id\": 1,\n \"isin\": \"INE002A01018\",\n \"exchange\": \"NSE\",\n \"source\": \"price\",\n \"category\": \"growth\",\n \"rule\": \"daily_gain\",\n \"severity\": \"info\",\n \"title\": \"Strong daily gain\",\n \"message\": \"The stock closed 4.25% higher for the day.\",\n \"observed_price\": \"3012.7500\",\n \"metrics\": {\n \"change_percent\": 4.25\n },\n \"trading_date\": \"2026-10-12\",\n \"observed_at\": \"2026-10-12T10:00:00+05:30\",\n \"expires_at\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Market Heatmap", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/heatmap?period=1m", "host": [ "{{baseUrl}}" ], "path": [ "market", "heatmap" ], "query": [ { "key": "period", "value": "1m" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/heatmap\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Market Snapshot", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/snapshot", "host": [ "{{baseUrl}}" ], "path": [ "market", "snapshot" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/snapshot\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Market Data by ISIN", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/equity/IN2920250163?live=1", "host": [ "{{baseUrl}}" ], "path": [ "market", "equity", "IN2920250163" ], "query": [ { "key": "live", "value": "1" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"type\": \"equity\",\n \"isin\": \"INE002A01018\",\n \"data\": {\n \"company\": {\n \"name\": \"RELIANCE INDUSTRIES LTD\",\n \"short_name\": \"Reliance\",\n \"logo_url\": \"https://setugeo.com/assets/equity-icons/INE002A01018.svg\",\n \"nse_symbol\": \"RELIANCE\",\n \"bse_symbol\": \"500325\",\n \"series\": \"EQ\",\n \"security_type\": \"NORMAL\",\n \"industry\": \"Oil & Gas\",\n \"market_lot\": 1,\n \"qty_multiplier\": 1,\n \"mtf_enabled\": true,\n \"mtf_bracket\": 26.5,\n \"cas_eligible\": true,\n \"intraday_margin\": 20,\n \"intraday_leverage\": 5,\n \"tick_size\": {\n \"nse\": 5,\n \"bse\": 5\n },\n \"freeze_quantity\": {\n \"nse\": 100000,\n \"bse\": null\n }\n },\n \"live_quote\": {\n \"price\": 1450.25,\n \"change\": 12.25,\n \"change_percent\": 0.85\n },\n \"fundamentals\": {\n \"market_cap\": null,\n \"pe_ratio\": null\n },\n \"price_history\": [\n {\n \"traded_date\": \"2026-10-12\",\n \"nse_open\": 1438,\n \"nse_high\": 1455,\n \"nse_low\": 1432.5,\n \"nse_close\": 1450.25,\n \"nse_prev_close\": 1438,\n \"nse_volume\": 1250000,\n \"bse_open\": 1437.8,\n \"bse_high\": 1454.9,\n \"bse_low\": 1432.25,\n \"bse_close\": 1450.1,\n \"bse_prev_close\": 1437.9,\n \"bse_volume\": 185000\n }\n ],\n \"corporate_actions\": [],\n \"news\": []\n }\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "List Global Instruments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/global-instruments?per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "global-instruments" ], "query": [ { "key": "per_page", "value": "10" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/global-instruments\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Dividends", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/dividends", "host": [ "{{baseUrl}}" ], "path": [ "market", "dividends" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/dividends\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "Get Corporate Actions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/corporate-actions?type=ALL&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "corporate-actions" ], "query": [ { "key": "type", "value": "ALL" }, { "key": "limit", "value": "10" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/corporate-actions\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "Get Complete Company Fundamentals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/company-fundamentals/IN2920250163?dataset=profile%2Ckey_ratios", "host": [ "{{baseUrl}}" ], "path": [ "market", "company-fundamentals", "IN2920250163" ], "query": [ { "key": "dataset", "value": "profile,key_ratios" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/company-fundamentals/{isin}\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Market News Feed", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/news?limit=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "news" ], "query": [ { "key": "limit", "value": "10" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/news\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "List Market Indices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/indices", "host": [ "{{baseUrl}}" ], "path": [ "market", "indices" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/indices\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "Get Market Quote by Symbol", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/quote/{symbol}", "host": [ "{{baseUrl}}" ], "path": [ "market", "quote", "{symbol}" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/quote/{symbol}\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get FII/DII Activity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/institutional-activity?investor_type=fii&interval=1D&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "institutional-activity" ], "query": [ { "key": "investor_type", "value": "fii" }, { "key": "interval", "value": "1D" }, { "key": "per_page", "value": "10" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/institutional-activity\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Splits", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/splits", "host": [ "{{baseUrl}}" ], "path": [ "market", "splits" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/splits\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "List IPOs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/ipos?status=open&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "market", "ipos" ], "query": [ { "key": "status", "value": "open" }, { "key": "per_page", "value": "10" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/ipos\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Sync Market Quotes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/sync?limit=5", "host": [ "{{baseUrl}}" ], "path": [ "market", "sync" ], "query": [ { "key": "limit", "value": "5" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/sync\",\n \"method\": \"POST\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "Get IPO Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/ipos/example-ipo", "host": [ "{{baseUrl}}" ], "path": [ "market", "ipos", "example-ipo" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/ipos/{slug}\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "List Recent Stock Nudges", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/nudges/fresh?per_page=25&date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "nudges", "fresh" ], "query": [ { "key": "per_page", "value": "25" }, { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-12\",\n \"data\": [\n {\n \"id\": 1,\n \"isin\": \"INE002A01018\",\n \"exchange\": \"NSE\",\n \"source\": \"price\",\n \"category\": \"growth\",\n \"rule\": \"daily_gain\",\n \"severity\": \"info\",\n \"title\": \"Strong daily gain\",\n \"message\": \"The stock closed 4.25% higher for the day.\",\n \"observed_price\": \"3012.7500\",\n \"metrics\": {\n \"change_percent\": 4.25\n },\n \"trading_date\": \"2026-10-12\",\n \"observed_at\": \"2026-10-12T10:00:00+05:30\",\n \"expires_at\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Market Data by ISIN", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/isin/IN2920250163?live=1", "host": [ "{{baseUrl}}" ], "path": [ "market", "isin", "IN2920250163" ], "query": [ { "key": "live", "value": "1" } ] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"type\": \"equity\",\n \"isin\": \"INE002A01018\",\n \"data\": {\n \"company\": {\n \"name\": \"RELIANCE INDUSTRIES LTD\",\n \"short_name\": \"Reliance\",\n \"logo_url\": \"https://setugeo.com/assets/equity-icons/INE002A01018.svg\",\n \"nse_symbol\": \"RELIANCE\",\n \"bse_symbol\": \"500325\",\n \"series\": \"EQ\",\n \"security_type\": \"NORMAL\",\n \"industry\": \"Oil & Gas\",\n \"market_lot\": 1,\n \"qty_multiplier\": 1,\n \"mtf_enabled\": true,\n \"mtf_bracket\": 26.5,\n \"cas_eligible\": true,\n \"intraday_margin\": 20,\n \"intraday_leverage\": 5,\n \"tick_size\": {\n \"nse\": 5,\n \"bse\": 5\n },\n \"freeze_quantity\": {\n \"nse\": 100000,\n \"bse\": null\n }\n },\n \"live_quote\": {\n \"price\": 1450.25,\n \"change\": 12.25,\n \"change_percent\": 0.85\n },\n \"fundamentals\": {\n \"market_cap\": null,\n \"pe_ratio\": null\n },\n \"price_history\": [\n {\n \"traded_date\": \"2026-10-12\",\n \"nse_open\": 1438,\n \"nse_high\": 1455,\n \"nse_low\": 1432.5,\n \"nse_close\": 1450.25,\n \"nse_prev_close\": 1438,\n \"nse_volume\": 1250000,\n \"bse_open\": 1437.8,\n \"bse_high\": 1454.9,\n \"bse_low\": 1432.25,\n \"bse_close\": 1450.1,\n \"bse_prev_close\": 1437.9,\n \"bse_volume\": 185000\n }\n ],\n \"corporate_actions\": [],\n \"news\": []\n }\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "List Stock Nudges by ISIN", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/nudges/isin/IN2920250163?per_page=25&date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "nudges", "isin", "IN2920250163" ], "query": [ { "key": "per_page", "value": "25" }, { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-12\",\n \"isin\": \"INE002A01018\",\n \"data\": [\n {\n \"id\": 1,\n \"isin\": \"INE002A01018\",\n \"exchange\": \"NSE\",\n \"source\": \"price\",\n \"category\": \"growth\",\n \"rule\": \"daily_gain\",\n \"severity\": \"info\",\n \"title\": \"Strong daily gain\",\n \"message\": \"The stock closed 4.25% higher for the day.\",\n \"observed_price\": \"3012.7500\",\n \"metrics\": {\n \"change_percent\": 4.25\n },\n \"trading_date\": \"2026-10-12\",\n \"observed_at\": \"2026-10-12T10:00:00+05:30\",\n \"expires_at\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Get Bonuses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market/bonuses", "host": [ "{{baseUrl}}" ], "path": [ "market", "bonuses" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market/bonuses\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] } ] }, { "name": "Mutual Funds", "item": [ { "name": "Search Mutual Funds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/search?q=360+ONE", "host": [ "{{baseUrl}}" ], "path": [ "mf", "search" ], "query": [ { "key": "q", "value": "360 ONE" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/search\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Similar Mutual Funds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/INF579M01AZ6/similar-funds?limit=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "INF579M01AZ6", "similar-funds" ], "query": [ { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/{isin}/similar-funds\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "List Mutual Funds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/list?per_page=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "list" ], "query": [ { "key": "per_page", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"data\": [\n {\n \"isin\": \"INF109K01VQ0\",\n \"scheme_code\": \"120503\",\n \"scheme_name\": \"Axis Bluechip Fund - Growth\",\n \"amc_name\": \"Axis Mutual Fund\",\n \"category\": \"Equity\",\n \"nav\": 54.32,\n \"nav_date\": \"2026-10-07\",\n \"chg_1d\": 0.42,\n \"chg_1y\": 18.74\n }\n ],\n \"sources\": {\n \"primary\": \"AMFI\",\n \"fallback\": \"Public mutual-fund instrument data\"\n },\n \"meta\": {\n \"total\": 13241,\n \"per_page\": 5,\n \"current_page\": 1,\n \"last_page\": 2649\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "List Mutual Fund Nudges", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/nudges?date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "mf", "nudges" ], "query": [ { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date_from\": \"2026-10-06\",\n \"date_to\": \"2026-10-12\",\n \"data\": [\n {\n \"id\": 1,\n \"isin\": \"INF109K01VQ0\",\n \"scheme_name\": \"Axis Bluechip Fund - Growth\",\n \"amc_name\": \"Axis Mutual Fund\",\n \"fund_category\": \"Equity\",\n \"category\": \"growth\",\n \"rule\": \"daily_gain\",\n \"severity\": \"significant\",\n \"title\": \"Axis Bluechip Fund NAV is up 5.25%\",\n \"observed_nav\": 54.32,\n \"nav_date\": \"2026-10-12\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Mutual Fund Filters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/filters", "host": [ "{{baseUrl}}" ], "path": [ "mf", "filters" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/filters\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Mutual Fund History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/history/INF579M01AZ6?months=6", "host": [ "{{baseUrl}}" ], "path": [ "mf", "history", "INF579M01AZ6" ], "query": [ { "key": "months", "value": "6" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/history/{isin}\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Compare Mutual Funds", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/compare?isins=INF579M01AZ6%2CINF579M01AV5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "compare" ], "query": [ { "key": "isins", "value": "INF579M01AZ6,INF579M01AV5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/compare\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Mutual Fund Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/details/INF579M01AZ6?date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "mf", "details", "INF579M01AZ6" ], "query": [ { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-07\",\n \"data\": {\n \"isin\": \"INF109K01VQ0\",\n \"scheme_code\": \"120503\",\n \"scheme_name\": \"Axis Bluechip Fund - Growth\",\n \"amc_name\": \"Axis Mutual Fund\",\n \"category\": \"Equity\",\n \"latest_nav\": 54.32,\n \"latest_nav_date\": \"2026-10-07\",\n \"returns\": {\n \"1d\": {\n \"return_pct\": 0.42,\n \"ref_nav\": 54.09\n },\n \"1y\": {\n \"return_pct\": 18.74,\n \"ref_nav\": 45.75\n }\n }\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Mutual Fund Analysis: Top Losers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/analysis/top-losers?period=1y&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "analysis", "top-losers" ], "query": [ { "key": "period", "value": "1y" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/analysis/top-losers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Mutual Fund Analysis: Top Gainers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/analysis/top-gainers?period=1y&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "analysis", "top-gainers" ], "query": [ { "key": "period", "value": "1y" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/analysis/top-gainers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Mutual Fund Analysis: Consistent Performers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/analysis/consistent-performers?periods=1m%2C3m%2C1y&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "analysis", "consistent-performers" ], "query": [ { "key": "periods", "value": "1m,3m,1y" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/analysis/consistent-performers\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Mutual Fund Analysis: Category Returns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/analysis/category-returns?period=1y&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "analysis", "category-returns" ], "query": [ { "key": "period", "value": "1y" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/analysis/category-returns\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Mutual Fund Analysis: Amc Performance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mf/analysis/amc-performance?period=1y&limit=5", "host": [ "{{baseUrl}}" ], "path": [ "mf", "analysis", "amc-performance" ], "query": [ { "key": "period", "value": "1y" }, { "key": "limit", "value": "5" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/mf/analysis/amc-performance\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "04. User & Account", "description": "Profile and customer account APIs.", "item": [ { "name": "User & Account", "item": [ { "name": "Get API Usage Breakdown", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user/usage-breakdown", "host": [ "{{baseUrl}}" ], "path": [ "user", "usage-breakdown" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/user/usage-breakdown\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get API Usage History", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user/usage-history", "host": [ "{{baseUrl}}" ], "path": [ "user", "usage-history" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/user/usage-history\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get API Usage Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user/usage", "host": [ "{{baseUrl}}" ], "path": [ "user", "usage" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/user/usage\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "05. OCR", "description": "OCR status and extraction APIs.", "item": [ { "name": "OCR", "item": [ { "name": "Check OCR Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ocr/health", "host": [ "{{baseUrl}}" ], "path": [ "ocr", "health" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/ocr/health\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] }, { "name": "Extract OCR Data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ocr/extract", "host": [ "{{baseUrl}}" ], "path": [ "ocr", "extract" ], "query": [] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/ocr/extract\",\n \"method\": \"POST\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "06. Webhooks", "description": "Webhook endpoints for integrations and event handling.", "item": [ { "name": "Webhooks", "item": [ { "name": "Webhooks Razorpay", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks/razorpay", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "razorpay" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/webhooks/razorpay\",\n \"method\": \"POST\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] } ] } ] }, { "name": "07. Other APIs", "description": "Additional APIs grouped for completeness.", "item": [ { "name": "Integrations", "item": [ { "name": "Integrations Market Data Upstox Token Secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/integrations/market-data/upstox-token/{secret}", "host": [ "{{baseUrl}}" ], "path": [ "integrations", "market-data", "upstox-token", "{secret}" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/integrations/market-data/upstox-token/{secret}\",\n \"method\": \"POST\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Resource Not Found", "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Requested resource was not found.\",\n \"data\": null\n}" } ] }, { "name": "Integration: Market Data Callback", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/integrations/market-data/callback", "host": [ "{{baseUrl}}" ], "path": [ "integrations", "market-data", "callback" ], "query": [] }, "description": "Does not require bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/integrations/market-data/callback\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" } ] } ] }, { "name": "Market-Calendar", "item": [ { "name": "Get Market Calendar Holidays", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market-calendar/holidays?exchange=all&type=holiday", "host": [ "{{baseUrl}}" ], "path": [ "market-calendar", "holidays" ], "query": [ { "key": "exchange", "value": "all" }, { "key": "type", "value": "holiday" } ] }, "description": "Requires bearer token. Returns all stored official NSE and BSE equity-market holidays. Use exchange=nse or exchange=bse for one exchange, and optionally filter by year or date range." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"filters\": {\n \"exchange\": \"all\",\n \"type\": \"holiday\"\n },\n \"count\": 2,\n \"data\": [\n {\n \"exchange\": \"NSE_BSE\",\n \"exchanges\": [\n \"NSE\",\n \"BSE\"\n ],\n \"segment\": \"equity\",\n \"date\": \"2026-01-26\",\n \"name\": \"Republic Day\",\n \"type\": \"holiday\",\n \"session_start\": null,\n \"session_end\": null,\n \"source\": \"nse_bse\",\n \"synced_at\": \"2026-01-01T06:00:00+05:30\"\n },\n {\n \"exchange\": \"NSE_BSE\",\n \"exchanges\": [\n \"NSE\",\n \"BSE\"\n ],\n \"segment\": \"equity\",\n \"date\": \"2026-03-04\",\n \"name\": \"Holi\",\n \"type\": \"holiday\",\n \"session_start\": null,\n \"session_end\": null,\n \"source\": \"nse_bse\",\n \"synced_at\": \"2026-01-01T06:00:00+05:30\"\n }\n ]\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] }, { "name": "Get Market Calendar Check", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/market-calendar/check?date=2026-10-17&exchange=all", "host": [ "{{baseUrl}}" ], "path": [ "market-calendar", "check" ], "query": [ { "key": "date", "value": "2026-10-17" }, { "key": "exchange", "value": "all" } ] }, "description": "Requires bearer token. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"message\": \"Request completed successfully.\",\n \"data\": {\n \"endpoint\": \"api/v1/market-calendar/check\",\n \"method\": \"GET\",\n \"sample\": \"Example response payload for demo purposes.\"\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] }, { "name": "Stock", "item": [ { "name": "List Stock Nudges", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock/nudges?date={{marketDate}}", "host": [ "{{baseUrl}}" ], "path": [ "stock", "nudges" ], "query": [ { "key": "date", "value": "{{marketDate}}" } ] }, "description": "Requires bearer token. Set marketDate to YYYY-MM-DD for an exact date, or leave it blank for the latest available data. Sample request is aligned with the in-app company API tester." }, "response": [ { "name": "Success", "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"success\": true,\n \"date\": \"2026-10-12\",\n \"data\": [\n {\n \"id\": 1,\n \"isin\": \"INE002A01018\",\n \"exchange\": \"NSE\",\n \"source\": \"price\",\n \"category\": \"growth\",\n \"rule\": \"daily_gain\",\n \"severity\": \"info\",\n \"title\": \"Strong daily gain\",\n \"message\": \"The stock closed 4.25% higher for the day.\",\n \"observed_price\": \"3012.7500\",\n \"metrics\": {\n \"change_percent\": 4.25\n },\n \"trading_date\": \"2026-10-12\",\n \"observed_at\": \"2026-10-12T10:00:00+05:30\",\n \"expires_at\": null\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 25,\n \"total\": 1\n }\n}" }, { "name": "Unauthenticated", "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Unauthenticated.\"\n}" }, { "name": "No Active Subscription", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"Payment Required. You do not have an active subscription.\"\n}" }, { "name": "Credits Exhausted", "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "body": "{\n \"status\": false,\n \"message\": \"API credits exhausted. Please upgrade your plan or wait for the next month for credit refresh.\"\n}" }, { "name": "Access Denied", "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "body": "{\n \"success\": false,\n \"message\": \"Your current plan does not include this API category.\",\n \"data\": null\n}" } ] } ] } ] }, { "name": "99. Manual Testing Notes", "item": [ { "name": "Bank: Ifsc Ifsc", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank/ifsc/{ifsc}", "host": [ "{{baseUrl}}" ], "path": [ "bank", "ifsc", "{ifsc}" ] }, "description": "Missing sample data for {ifsc}." } }, { "name": "List Bank Branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank/{bank}/branches", "host": [ "{{baseUrl}}" ], "path": [ "bank", "{bank}", "branches" ] }, "description": "Missing sample data for {bank}." } }, { "name": "Get Bank Coverage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank/{bank}/coverage", "host": [ "{{baseUrl}}" ], "path": [ "bank", "{bank}", "coverage" ] }, "description": "Missing sample data for {bank}." } }, { "name": "List Bank SWIFT Branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank/{bank}/swift-branches", "host": [ "{{baseUrl}}" ], "path": [ "bank", "{bank}", "swift-branches" ] }, "description": "Missing sample data for {bank}." } }, { "name": "List Bank Branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/banks/{bank}/branches", "host": [ "{{baseUrl}}" ], "path": [ "banks", "{bank}", "branches" ] }, "description": "Missing sample data for {bank}." } }, { "name": "Get Bank Coverage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/banks/{bank}/coverage", "host": [ "{{baseUrl}}" ], "path": [ "banks", "{bank}", "coverage" ] }, "description": "Missing sample data for {bank}." } }, { "name": "Get Bank Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branch/{ifsc}", "host": [ "{{baseUrl}}" ], "path": [ "branch", "{ifsc}" ] }, "description": "Missing sample data for {ifsc}." } }, { "name": "Get City Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cities/{city}", "host": [ "{{baseUrl}}" ], "path": [ "cities", "{city}" ] }, "description": "Missing sample data for {city}." } }, { "name": "List City Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/cities/{city}/banks", "host": [ "{{baseUrl}}" ], "path": [ "cities", "{city}", "banks" ] }, "description": "Missing sample data for {city}." } }, { "name": "Get City Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/city/{city}", "host": [ "{{baseUrl}}" ], "path": [ "city", "{city}" ] }, "description": "Missing sample data for {city}." } }, { "name": "List City Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/city/{city}/banks", "host": [ "{{baseUrl}}" ], "path": [ "city", "{city}", "banks" ] }, "description": "Missing sample data for {city}." } }, { "name": "Get Country Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/{country}", "host": [ "{{baseUrl}}" ], "path": [ "countries", "{country}" ] }, "description": "Missing sample data for {country}." } }, { "name": "List Country Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/{country}/banks", "host": [ "{{baseUrl}}" ], "path": [ "countries", "{country}", "banks" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/{country}/cities", "host": [ "{{baseUrl}}" ], "path": [ "countries", "{country}", "cities" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Neighbors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/{country}/neighbors", "host": [ "{{baseUrl}}" ], "path": [ "countries", "{country}", "neighbors" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country States", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/{country}/states", "host": [ "{{baseUrl}}" ], "path": [ "countries", "{country}", "states" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Timezones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/countries/{country}/timezones", "host": [ "{{baseUrl}}" ], "path": [ "countries", "{country}", "timezones" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}" ] }, "description": "Missing sample data for {country}." } }, { "name": "List Country Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}/banks", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}", "banks" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}/cities", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}", "cities" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Economic Summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}/economic-summary", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}", "economic-summary" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Neighbors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}/neighbors", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}", "neighbors" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country States", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}/states", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}", "states" ] }, "description": "Missing sample data for {country}." } }, { "name": "Get Country Timezones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/country/{country}/timezones", "host": [ "{{baseUrl}}" ], "path": [ "country", "{country}", "timezones" ] }, "description": "Missing sample data for {country}." } }, { "name": "Indium: Pincode Pincode", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/india/pincode/{pincode}", "host": [ "{{baseUrl}}" ], "path": [ "india", "pincode", "{pincode}" ] }, "description": "Missing sample data for {pincode}." } }, { "name": "Get Pincode Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pincode/{pincode}", "host": [ "{{baseUrl}}" ], "path": [ "pincode", "{pincode}" ] }, "description": "Missing sample data for {pincode}." } }, { "name": "List Pincode Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pincode/{pincode}/banks", "host": [ "{{baseUrl}}" ], "path": [ "pincode", "{pincode}", "banks" ] }, "description": "Missing sample data for {pincode}." } }, { "name": "List Pincode Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pincodes/{pincode}/banks", "host": [ "{{baseUrl}}" ], "path": [ "pincodes", "{pincode}", "banks" ] }, "description": "Missing sample data for {pincode}." } }, { "name": "Get State Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/state/{state}", "host": [ "{{baseUrl}}" ], "path": [ "state", "{state}" ] }, "description": "Missing sample data for {state}." } }, { "name": "List State Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/state/{state}/banks", "host": [ "{{baseUrl}}" ], "path": [ "state", "{state}", "banks" ] }, "description": "Missing sample data for {state}." } }, { "name": "Get State Cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/state/{state}/cities", "host": [ "{{baseUrl}}" ], "path": [ "state", "{state}", "cities" ] }, "description": "Missing sample data for {state}." } }, { "name": "Get State Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/states/{state}", "host": [ "{{baseUrl}}" ], "path": [ "states", "{state}" ] }, "description": "Missing sample data for {state}." } }, { "name": "List State Banks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/states/{state}/banks", "host": [ "{{baseUrl}}" ], "path": [ "states", "{state}", "banks" ] }, "description": "Missing sample data for {state}." } }, { "name": "Get State Cities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/states/{state}/cities", "host": [ "{{baseUrl}}" ], "path": [ "states", "{state}", "cities" ] }, "description": "Missing sample data for {state}." } } ] } ] }