From d529b7ea26db61dade4514b4b21742dc8dab4953 Mon Sep 17 00:00:00 2001 From: setu-kailas Date: Mon, 2 Jun 2025 19:36:53 +0530 Subject: [PATCH 1/5] pre format --- api-references/data/insights.json | 37 +++++++++++++++---------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index 38d93223..f100d40e 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -16,7 +16,6 @@ } ], "paths": { - "/v2/fiData": { "post": { "tags": [ @@ -1416,25 +1415,25 @@ "title": "FIDataBlockResponse" }, "FIDataList": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/DepositData" - }, - { - "$ref": "#/components/schemas/MutualFundsData" - }, - { - "$ref": "#/components/schemas/EquitiesData" + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/DepositData" + }, + { + "$ref": "#/components/schemas/MutualFundsData" + }, + { + "$ref": "#/components/schemas/EquitiesData" + }, + { + "$ref": "#/components/schemas/ETFData" + } + ] + }, + "title": "FIDataList" }, - { - "$ref": "#/components/schemas/ETFData" - } - ] - }, - "title": "FIDataList" -}, "FIUConfig": { "properties": { "fiuId": { From c2fec804cc78fcd2df3831971a39d17428cc1fc8 Mon Sep 17 00:00:00 2001 From: setu-kailas Date: Mon, 2 Jun 2025 20:03:34 +0530 Subject: [PATCH 2/5] added deposit and equities insights docs --- api-references/data/insights.json | 776 ++++++++++++++++++++++++++++++ 1 file changed, 776 insertions(+) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index f100d40e..87ce9795 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -772,6 +772,321 @@ } } } + }, + "/v1/deposit/transactions": { + "post": { + "tags": [ + "Insights" + ], + "summary": "List Deposit Transactions", + "description": "Retrieves a list of deposit account transactions based on provided filters and pagination parameters.", + "operationId": "list-deposit-transactions", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "x-product-instance-id" + }, + "name": "x-product-instance-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-id" + }, + "name": "x-client-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-secret" + }, + "name": "x-client-secret", + "in": "header" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListDepositTransactionsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListDepositTransactionsResponse" + }, + "examples": { + "SuccessResponse": { + "summary": "SuccessResponse", + "value": { + "status": "Success", + "body": [ + { + "totalCount": 3, + "data": [ + { + "id": "01XYZHR0K3SGPV3CTPF7TPF5F4", + "refId": "3642496001329000000", + "dataId": "", + "consentId": "", + "linkedAccRef": "5af25502-6b0f-4e10-906f-b8a11ae6c999", + "fipId": "setu-fip-2", + "txnId": "FDYG00500930000000", + "txnType": "DEBIT", + "txnMode": "ATM", + "txnTimestamp": "2023-01-13T20:18:16Z", + "txnValueDate": "2023-01-14T20:18:16Z", + "narration": "ATM/DE/193384537054/Pihu Wadhwa/IGHE/10042865", + "reference": "152804000", + "transactionMode": "CASH", + "counterparty": "Pihu Wadhwa", + "categoryL1": "Cash Withdrawal", + "categoryL2": "Cash Withdrawal", + "categoryManual": "", + "amount": 49300.00, + "currentBalance": 232900.00 + }, + { + "id": "01JWBHR0BH6J5NVXTY7TB0ABC5", + "refId": "3642496001253000000", + "dataId": "", + "consentId": "", + "linkedAccRef": "fa85b8b4-52c6-4ae6-81b3-d8d625b19999", + "fipId": "setu-fip-2", + "txnId": "FDYG00500930999999", + "txnType": "DEBIT", + "txnMode": "ATM", + "txnTimestamp": "2023-01-13T20:18:16Z", + "txnValueDate": "2023-01-14T20:18:16Z", + "narration": "ATM/DE/193384537054/Pihu Wadhwa/IGHE/10042865", + "reference": "152804999", + "transactionMode": "CASH", + "counterparty": "Pihu Wadhwa", + "categoryL1": "Cash Withdrawal", + "categoryL2": "Cash Withdrawal", + "categoryManual": "", + "amount": 49399.99, + "currentBalance": 232999.99 + }, + { + "id": "01JWBHR0K3X98W0FRB2QQP7XYZ", + "refId": "3642496001329001111", + "dataId": "", + "consentId": "", + "linkedAccRef": "5af25502-6b0f-4e10-906f-b8a11ae6c777", + "fipId": "setu-fip-2", + "txnId": "DUIX70560000000000", + "txnType": "CREDIT", + "txnMode": "FT", + "txnTimestamp": "2023-03-11T00:00:52Z", + "txnValueDate": "2023-03-12T00:00:52Z", + "narration": "FT/CR/401095631252/Pihu Wadhwa/QIKB/51614914", + "reference": "204584000", + "transactionMode": "OTHERS", + "counterparty": "Pihu Wadhwa", + "categoryL1": "Transfer", + "categoryL2": "P2A Inward", + "categoryManual": "", + "amount": 17900.00, + "currentBalance": 241300.00 + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceBadRequest" + }, + "examples": { + "BadRequestResponse": { + "summary": "BadRequestResponse", + "value": { + "message": "Product instance ID required" + } + } + } + } + } + }, + "401": { + "description": "Authentication Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceUnauthorized" + }, + "examples": { + "AuthenticationErrorResponse": { + "summary": "AuthenticationErrorResponse", + "value": { + "message": "Unauthorized" + } + } + } + } + } + } + } + } + }, + "/v1/equities/transactions": { + "post": { + "tags": [ + "Insights" + ], + "summary": "List equities transactions", + "description": "Retrieves a list of equity investment transactions based on provided filters and pagination parameters.", + "operationId": "list-equities-transactions", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "x-product-instance-id" + }, + "name": "x-product-instance-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-id" + }, + "name": "x-client-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-secret" + }, + "name": "x-client-secret", + "in": "header" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListEquitiesTransactionsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListEquitiesTransactionsResponse" + }, + "examples": { + "SuccessResponse": { + "summary": "SuccessResponse", + "value": { + "status": "Success", + "body": [ + { + "totalCount": 1, + "data": [ + { + "id": "01SAMPLE04R46QZNQ28YM2C6E4S", + "createdAt": "2024-10-31T18:35:00Z", + "updatedAt": "2024-10-31T18:35:00Z", + "isDeleted": false, + "refId": "sample-equity-ref-001", + "dataId": "equity-data-block-001", + "consentId": "equity-consent-12345", + "linkedAccRef": "NSDLLINK00000000000000SAMPLE", + "productAccountId": "prod-equity-acc-001", + "fipId": "fip@nsdl", + "txnId": "EQUITY123456789", + "txnType": "BUY", + "txnDateTime": "2024-10-31T18:30:00Z", + "orderId": "ORD2024103101", + "exchange": "NSE", + "isin": "INE002A01018", + "isinDescription": "Reliance Industries Limited", + "companyName": "RELIANCE INDUSTRIES LIMITED", + "equityCategory": "EQUITY", + "narration": "Purchase of equity shares", + "exchangeRate": 1338.65, + "units": 11, + "dematId": "DEMAT123456" + } + ] + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceBadRequest" + }, + "examples": { + "BadRequestResponse": { + "summary": "BadRequestResponse", + "value": { + "message": "Product instance ID required" + } + } + } + } + } + }, + "401": { + "description": "Authentication Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceUnauthorized" + }, + "examples": { + "UnauthorizedResponse": { + "summary": "UnauthorizedResponse", + "value": { + "message": "Unauthorized" + } + } + } + } + } + } + } + } } }, "components": { @@ -1661,6 +1976,467 @@ "type": "object", "title": "InsightParam" }, + "InsightListDepositTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "maximum": 500 + }, + "offset": { + "type": "integer" + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "orderBy": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "enum": [ + "ref_id", + "data_id", + "linked_acc_ref", + "product_account_id", + "txn_id", + "txn_mode", + "txn_type", + "txn_timestamp", + "txn_value_date", + "narration", + "amount", + "current_balance", + "reference", + "category_l1", + "category_l2", + "category_manual" + ] + }, + "order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + "required": [ + "field", + "order" + ] + } + }, + "where": { + "type": "array", + "items": { + "type": "object", + "properties": { + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "txnMode": { + "type": "string" + }, + "txnTimestamp": { + "type": "string", + "format": "date-time" + }, + "txnValueDate": { + "type": "string", + "format": "date-time" + }, + "narration": { + "type": "string" + }, + "amount": { + "type": "number", + "minimum": 0.0 + }, + "currentBalance": { + "type": "number", + "minimum": 0.0 + }, + "reference": { + "type": "string" + }, + "transactionMode": { + "type": "string" + }, + "counterparty": { + "type": "string" + }, + "categoryL1": { + "type": "string" + }, + "categoryL2": { + "type": "string" + }, + "categoryManual": { + "type": "string" + }, + "amount_gte": { + "type": "number", + "minimum": 0.0 + }, + "amount_lte": { + "type": "number", + "minimum": 0.0 + }, + "txnTimestamp_gte": { + "type": "string", + "format": "date-time" + }, + "txnTimestamp_lte": { + "type": "string", + "format": "date-time" + }, + "categoryL1_list": { + "type": "array", + "items": { + "type": "string" + } + }, + "categoryL2_list": { + "type": "array", + "items": { + "type": "string" + } + }, + "categoryManual_list": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "InsightListDepositTransactionsResponse": { + "properties": { + "totalCount": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "refId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "consentId": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "txnMode": { + "type": "string" + }, + "txnTimestamp": { + "type": "string", + "format": "date-time" + }, + "txnValueDate": { + "type": "string", + "format": "date-time" + }, + "narration": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "transactionMode": { + "type": "string" + }, + "counterparty": { + "type": "string" + }, + "categoryL1": { + "type": "string" + }, + "categoryL2": { + "type": "string" + }, + "categoryManual": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + }, + "currentBalance": { + "type": "number", + "format": "float" + } + } + } + } + } + }, + "InsightListEquitiesTransactionsRequest": { + "type": "object", + "properties": { + "refIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of reference IDs to filter transactions" + }, + "where": { + "type": "array", + "items": { + "type": "object", + "properties": { + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "txnDateTime": { + "type": "string", + "format": "date-time" + }, + "orderId": { + "type": "string" + }, + "exchange": { + "type": "string" + }, + "isin": { + "type": "string" + }, + "isinDescription": { + "type": "string" + }, + "companyName": { + "type": "string" + }, + "equityCategory": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "dematId": { + "type": "string" + }, + "units": { + "type": "number", + "minimum": 0.0 + }, + "units_gte": { + "type": "number", + "minimum": 0.0 + }, + "units_lte": { + "type": "number", + "minimum": 0.0 + }, + "exchangeRate": { + "type": "number", + "minimum": 0.0 + }, + "exchangeRate_gte": { + "type": "number", + "minimum": 0.0 + }, + "exchangeRate_lte": { + "type": "number", + "minimum": 0.0 + }, + "transactionDateTime_gte": { + "type": "string", + "format": "date-time" + }, + "transactionDateTime_lte": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false + }, + "description": "Filter conditions for the query" + }, + "orderBy": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "enum": [ + "id", + "ref_id", + "data_id", + "consent_id", + "linked_acc_ref", + "product_account_id", + "fip_id", + "txn_id", + "order_id", + "company_name", + "transaction_date_time", + "exchange", + "isin", + "isin_description", + "equity_category", + "narration", + "exchange_rate", + "units", + "type", + "demat_id" + ], + "description": "Field to sort by (must be one of the allowed fields)" + }, + "order": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "description": "Sort order (ascending or descending)" + } + }, + "required": [ + "field", + "order" + ], + "additionalProperties": false + }, + "description": "Sorting criteria for the results" + }, + "limit": { + "type": "integer", + "description": "Maximum number of records to return", + "maximum": 500 + }, + "offset": { + "type": "integer", + "description": "Number of records to skip for pagination" + } + } + }, + "InsightListEquitiesTransactionsResponse": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "refId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "consentId": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "txnDateTime": { + "type": "string", + "format": "date-time" + }, + "orderId": { + "type": "string" + }, + "exchange": { + "type": "string" + }, + "isin": { + "type": "string" + }, + "isinDescription": { + "type": "string" + }, + "companyName": { + "type": "string" + }, + "equityCategory": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "exchangeRate": { + "type": "number" + }, + "units": { + "type": "number" + }, + "dematId": { + "type": "string" + } + } + }, + "description": "Array of equity transaction objects" + } + } + }, + "InsightTransactionServiceBadRequest": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "InsightTransactionServiceUnauthorized": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, "KeywordMap": { "properties": { "id": { From 53c7327176f3c341e4153dea1c63f263746b2e33 Mon Sep 17 00:00:00 2001 From: setu-kailas Date: Mon, 2 Jun 2025 20:05:27 +0530 Subject: [PATCH 3/5] added etf docs for insights --- api-references/data/insights.json | 354 ++++++++++++++++++++++++++++++ 1 file changed, 354 insertions(+) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index 87ce9795..9e6b7a76 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -1087,6 +1087,154 @@ } } } + }, + "/v1/etf/transactions": { + "post": { + "tags": [ + "Insights" + ], + "summary": "List etf transactions", + "description": "Retrieves a list of ETF (Exchange Traded Fund) transactions based on provided filters and pagination parameters.", + "operationId": "list-etf-transactions", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "x-product-instance-id" + }, + "name": "x-product-instance-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-id" + }, + "name": "x-client-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-secret" + }, + "name": "x-client-secret", + "in": "header" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListETFTransactionsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListETFTransactionsResponse" + }, + "examples": { + "SuccessResponse": { + "summary": "SuccessResponse", + "value": { + "status": "Success", + "body": { + "totalCount": 2, + "data": [ + { + "id": "01SAMPLE1PAGPEKV9FXTKQ9JWN5", + "refId": "etf-sample-ref-001", + "dataId": "etf-data-block-001", + "consentId": "etf-consent-12345", + "linkedAccRef": "sample-etf-acc-ref-001", + "fipId": "setu-fip", + "txnId": "ETF63944T6", + "txnType": "BUY", + "transactionDateTime": "2015-10-07T18:20:00Z", + "brokerCode": "BRK001", + "isin": "INUSETF001625-0", + "isinDescription": "Sample ETF Index Fund", + "narration": "Purchase of ETF units", + "nav": 2100, + "amount": 42000, + "units": 20, + "dematId": "DEMAT567890" + }, + { + "id": "02SAMPLE2PAVDAY0MY8F4YTATRV", + "refId": "etf-sample-ref-001", + "dataId": "etf-data-block-002", + "consentId": "etf-consent-12345", + "linkedAccRef": "sample-etf-acc-ref-001", + "fipId": "setu-fip", + "txnId": "ETF63944T6", + "txnType": "SELL", + "transactionDateTime": "2021-01-12T18:20:00Z", + "brokerCode": "BRK001", + "isin": "INUSETF001625-0", + "isinDescription": "Sample ETF Index Fund", + "narration": "Sale of ETF units", + "nav": 2100, + "amount": 31500, + "units": 15, + "dematId": "DEMAT567890" + } + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceBadRequest" + }, + "examples": { + "BadRequestResponse": { + "summary": "BadRequestResponse", + "value": { + "message": "Product instance ID required" + } + } + } + } + } + }, + "401": { + "description": "Authentication Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceUnauthorized" + }, + "examples": { + "UnauthorizedResponse": { + "summary": "UnauthorizedResponse", + "value": { + "message": "Unauthorized" + } + } + } + } + } + } + } + } } }, "components": { @@ -2421,6 +2569,212 @@ } } }, + "InsightListETFTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "maximum": 500 + }, + "offset": { + "type": "integer" + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "orderBy": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "enum": [ + "id", + "ref_id", + "data_id", + "consent_id", + "linked_acc_ref", + "product_account_id", + "fip_id", + "txn_id", + "transaction_date_time", + "broker_code", + "isin", + "isin_description", + "nav", + "narration", + "amount", + "units", + "txn_type", + "demat_id" + ] + }, + "order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + "required": [ + "field", + "order" + ] + } + }, + "where": { + "type": "array", + "items": { + "type": "object", + "properties": { + "amount": { + "type": "number", + "minimum": 0.0 + }, + "amount_gte": { + "type": "number", + "minimum": 0.0 + }, + "amount_lte": { + "type": "number", + "minimum": 0.0 + }, + "brokerCode": { + "type": "string" + }, + "dematId": { + "type": "string" + }, + "isin": { + "type": "string" + }, + "isinDescription": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "nav": { + "type": "number", + "minimum": 0.0 + }, + "nav_gte": { + "type": "number", + "minimum": 0.0 + }, + "nav_lte": { + "type": "number", + "minimum": 0.0 + }, + "transactionDateTime": { + "type": "string", + "format": "date-time" + }, + "transactionDateTime_gte": { + "type": "string", + "format": "date-time" + }, + "transactionDateTime_lte": { + "type": "string", + "format": "date-time" + }, + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "units": { + "type": "number", + "minimum": 0.0 + }, + "units_gte": { + "type": "number", + "minimum": 0.0 + }, + "units_lte": { + "type": "number", + "minimum": 0.0 + } + } + } + } + } + }, + "InsightListETFTransactionsResponse": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "refId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "consentId": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "transactionDateTime": { + "type": "string", + "format": "date-time" + }, + "brokerCode": { + "type": "string" + }, + "isin": { + "type": "string" + }, + "isinDescription": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "nav": { + "type": "number" + }, + "amount": { + "type": "number" + }, + "units": { + "type": "number" + }, + "dematId": { + "type": "string" + } + } + }, + "description": "Array of ETF transaction objects" + } + } + }, "InsightTransactionServiceBadRequest": { "type": "object", "properties": { From 83cffd1c23ffb396832486e51e6cc60a6fe9d5cf Mon Sep 17 00:00:00 2001 From: setu-kailas Date: Mon, 2 Jun 2025 20:07:01 +0530 Subject: [PATCH 4/5] added mutual funds api docs in insights --- api-references/data/insights.json | 409 ++++++++++++++++++++++++++++++ 1 file changed, 409 insertions(+) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index 9e6b7a76..0c81307d 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -1235,6 +1235,138 @@ } } } + }, + "/v1/mutual-funds/transactions": { + "post": { + "tags": [ + "Insights" + ], + "summary": "List mutual-funds transactions", + "description": "Retrieves a list of mutual fund transactions based on provided filters and pagination parameters.", + "operationId": "list-mutual-funds-transactions", + "parameters": [ + { + "required": true, + "schema": { + "type": "string", + "title": "x-product-instance-id" + }, + "name": "x-product-instance-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-id" + }, + "name": "x-client-id", + "in": "header" + }, + { + "required": true, + "schema": { + "type": "string", + "title": "x-client-secret" + }, + "name": "x-client-secret", + "in": "header" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListMutualFundsTransactionsRequest" + } + } + }, + "required": true, + "description": "List of Equities Transactions" + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightListMutualFundsTransactionsResponse" + }, + "examples": { + "SuccessResponse": { + "summary": "SuccessResponse", + "value": { + "status": "Success", + "body": { + "totalCount": 1, + "data": [ + { + "id": "01SAMPLE04R46QZNQ28YM2C6E4S", + "refId": "sample-equity-ref-001", + "dataId": "equity-data-block-001", + "consentId": "equity-consent-12345", + "linkedAccRef": "NSDLLINK00000000000000SAMPLE", + "fipId": "fip@nsdl", + "txnId": "EQUITY123456789", + "txnType": "BUY", + "txnDateTime": "2024-10-31T18:30:00Z", + "orderId": "ORD2024103101", + "exchange": "NSE", + "isin": "INE002A01018", + "isinDescription": "Reliance Industries Limited", + "companyName": "RELIANCE INDUSTRIES LIMITED", + "equityCategory": "EQUITY", + "narration": "Purchase of equity shares", + "exchangeRate": 1338.65, + "units": 11, + "dematId": "DEMAT123456" + } + ] + } + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceBadRequest" + }, + "examples": { + "BadRequestResponse": { + "summary": "BadRequestResponse", + "value": { + "message": "Product instance ID required" + } + } + } + } + } + }, + "401": { + "description": "Authentication Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InsightTransactionServiceUnauthorized" + }, + "examples": { + "UnauthorizedResponse": { + "summary": "UnauthorizedResponse", + "value": { + "message": "Unauthorized" + } + } + } + } + } + } + } + } } }, "components": { @@ -2775,6 +2907,283 @@ } } }, + "InsightListMutualFundsTransactionsRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "maximum": 500 + }, + "offset": { + "type": "integer" + }, + "refIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "orderBy": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "enum": [ + "id", + "ref_id", + "data_id", + "consent_id", + "linked_acc_ref", + "product_account_id", + "fip_id", + "txn_id", + "txn_mode", + "txn_type", + "txn_date", + "amc", + "registrar", + "scheme_code", + "scheme_plan", + "isin", + "isin_description", + "amfi_code", + "ucc", + "amount", + "nav_date", + "lock_in_flag", + "lock_in_days", + "narration", + "units", + "amc_full_name", + "mutual_fund_name" + ] + }, + "order": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + "required": [ + "field", + "order" + ] + } + }, + "where": { + "type": "array", + "items": { + "type": "object", + "properties": { + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "txnDate": { + "type": "string", + "format": "date" + }, + "txnMode": { + "type": "string" + }, + "amc": { + "type": "string" + }, + "registrar": { + "type": "string" + }, + "schemeCode": { + "type": "string" + }, + "schemePlan": { + "type": "string" + }, + "isin": { + "type": "string" + }, + "isinDescription": { + "type": "string" + }, + "amfiCode": { + "type": "string" + }, + "ucc": { + "type": "string" + }, + "navDate": { + "type": "string", + "format": "date" + }, + "lockInFlag": { + "type": "string" + }, + "lockInDays": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "amcFullName": { + "type": "string" + }, + "mutualFundName": { + "type": "string" + }, + "amount": { + "type": "number", + "minimum": 0 + }, + "amount_gte": { + "type": "number", + "minimum": 0 + }, + "amount_lte": { + "type": "number", + "minimum": 0 + }, + "units": { + "type": "number", + "minimum": 0 + }, + "units_gte": { + "type": "number", + "minimum": 0 + }, + "units_lte": { + "type": "number", + "minimum": 0 + }, + "nav": { + "type": "number", + "minimum": 0 + }, + "nav_gte": { + "type": "number", + "minimum": 0 + }, + "nav_lte": { + "type": "number", + "minimum": 0 + }, + "txnDate_gte": { + "type": "string", + "format": "date" + }, + "txnDate_lte": { + "type": "string", + "format": "date" + } + } + } + } + } + }, + "InsightListMutualFundsTransactionsResponse": { + "type": "object", + "properties": { + "totalCount": { + "type": "integer", + "description": "Total number of equity transactions matching the filter" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "refId": { + "type": "string" + }, + "dataId": { + "type": "string" + }, + "consentId": { + "type": "string" + }, + "linkedAccRef": { + "type": "string" + }, + "fipId": { + "type": "string" + }, + "txnId": { + "type": "string" + }, + "txnType": { + "type": "string" + }, + "txnDate": { + "type": "string", + "format": "date-time" + }, + "txnMode": { + "type": "string" + }, + "amc": { + "type": "string" + }, + "registrar": { + "type": "string" + }, + "schemeCode": { + "type": "string" + }, + "schemePlan": { + "type": "string" + }, + "isin": { + "type": "string" + }, + "isinDescription": { + "type": "string" + }, + "amfiCode": { + "type": "string" + }, + "ucc": { + "type": "string" + }, + "nav": { + "type": "number" + }, + "amount": { + "type": "number" + }, + "navDate": { + "type": "string", + "format": "date-time" + }, + "lockInFlag": { + "type": "string" + }, + "lockInDays": { + "type": "string" + }, + "narration": { + "type": "string" + }, + "units": { + "type": "number" + }, + "amcFullName": { + "type": "string" + }, + "mutualFundName": { + "type": "string" + } + } + } + } + } + }, "InsightTransactionServiceBadRequest": { "type": "object", "properties": { From 8d28efa7330785b90f59fb81976818065430775c Mon Sep 17 00:00:00 2001 From: setu-kailas Date: Thu, 5 Jun 2025 18:02:44 +0530 Subject: [PATCH 5/5] upadate routing and tags --- api-references/data/insights.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/api-references/data/insights.json b/api-references/data/insights.json index 0c81307d..78caa4d6 100644 --- a/api-references/data/insights.json +++ b/api-references/data/insights.json @@ -773,10 +773,10 @@ } } }, - "/v1/deposit/transactions": { + "/v2/deposit/transactions": { "post": { "tags": [ - "Insights" + "List transactions" ], "summary": "List Deposit Transactions", "description": "Retrieves a list of deposit account transactions based on provided filters and pagination parameters.", @@ -951,10 +951,10 @@ } } }, - "/v1/equities/transactions": { + "/v2/equities/transactions": { "post": { "tags": [ - "Insights" + "List transactions" ], "summary": "List equities transactions", "description": "Retrieves a list of equity investment transactions based on provided filters and pagination parameters.", @@ -1088,10 +1088,10 @@ } } }, - "/v1/etf/transactions": { + "/v2/etf/transactions": { "post": { "tags": [ - "Insights" + "List transactions" ], "summary": "List etf transactions", "description": "Retrieves a list of ETF (Exchange Traded Fund) transactions based on provided filters and pagination parameters.", @@ -1236,10 +1236,10 @@ } } }, - "/v1/mutual-funds/transactions": { + "/v2/mutual-funds/transactions": { "post": { "tags": [ - "Insights" + "List transactions" ], "summary": "List mutual-funds transactions", "description": "Retrieves a list of mutual fund transactions based on provided filters and pagination parameters.",