---
title: "Credit limit simulation"
method: POST
path: "/backend/{gatewayname}/v1/creditlimit/simulation"
---

# Credit limit simulation

`POST /backend/{gatewayname}/v1/creditlimit/simulation`

Determine the loan amount that can be drawn against user's mutual fund and stock holdings.

## Path parameters

- `gatewayname` string, required

## Query parameters

- `aggregateFunds` boolean

## Headers

- `x-gateway-secret` string, required
- `x-gateway-authtoken` string, required

## Request body

- object
  - `securities` object[], required — Required | Array of the user's MF and/or stock holdings.
    - `assetType` 'MUTUALFUND' | 'STOCKS', required — MUTUALFUND for MF holdings, STOCKS for stocks.
    - `isin` string, required — ISIN of the holding. The same ISIN can repeat for STOCKS held across multiple smallcases.
    - `quantity` number, double, required — Number of units held.
    - `isDemat` boolean — true if held in demat form (always true for STOCKS); false for SoA / RTA.
    - `lockInQuantity` number, double — Units not available for pledging; deducted from quantity. Either lockInQuantity or lienEligibleUnits can be passed (lienEligibleUnits is prioritised if both are present).
    - `lienEligibleUnits` number, double — Units available for pledging. Either lockInQuantity or lienEligibleUnits can be passed (lienEligibleUnits is prioritised if both are present).
    - `dpId` string — 16-digit DP (Depository Participant) ID. Mandatory for any security with isDemat: true (always required for STOCKS).
    - `iscid` string — STOCKS only. Empty if held externally; populated when the holding is a smallcase constituent.
  - `brokerHoldings` object[] — Optional. Broker raw holdings (currently kite) for cross-validation against securities[].
    - `broker` string
    - `holdings` object[]
      - `isin` string
      - `units` number
  - `referrer` string — Optional. Defaults to your partner name.
  - `pan` string — Optional. User's PAN.
  - `age` number — Optional. Validated against the lender's allowed age range when provided.
  - `isNri` boolean — Optional. Use isNri (isNRI is deprecated). NRI users are rejected with not_eligible_wrt_nri_status (4407).
  - `name` string — Optional. User's name.
  - `lender` string — Optional. Omit to get the best offer across all eligible lenders.

## Response `200`

200

- object
  - `code` integer
  - `data` object
    - `distribution` object[]
      - `assetType` string
      - `securityCode` string
      - `securityName` string
      - `securityKey` string
      - `sid` string — STOCKS only. Stock identifier.
      - `isETF` boolean — STOCKS only.
      - `riskCategory` integer — STOCKS only. Risk bucket 1-4.
      - `category` string
      - `inputQuantity` number
      - `allowableQty` number
      - `selectedQuantity` number — STOCKS only. Units selected for this holding.
      - `price` number
      - `marketValue` number
      - `totalMarketValue` number — Market value including lock-in units.
      - `inputLTV` integer
      - `actualLTV` integer
      - `bufferLTV` integer
      - `drawingPower` integer
      - `isDemat` boolean
      - `dpId` string — Present for STOCKS / demat holdings.
      - `iscid` string — STOCKS only.
      - `isEligible` boolean
    - `flags` object
      - `isDematEnabled` boolean
    - `summary` object — Returned only when aggregateFunds is set to true.
      - `category` object
        - `debt` object
          - `marketValue` number
          - `ltv` number
          - `drawingPower` number
          - `marketValueEligible` number
          - `marketValueInEligible` number
        - `equity` object
          - `marketValue` number
          - `ltv` number
          - `drawingPower` number
          - `marketValueEligible` number
          - `marketValueInEligible` number
        - `stocks` object
          - `marketValue` number
          - `ltv` number
          - `drawingPower` number
          - `marketValueEligible` number
          - `marketValueInEligible` number
        - `etfs` object
          - `marketValue` number
          - `ltv` number
          - `drawingPower` number
          - `marketValueEligible` number
          - `marketValueInEligible` number
      - `maxDrawingAmount` integer
      - `maxMarketValueForEligible` number
      - `maxMarketValueForInEligible` number
    - `lender` string — The selected / best-offer lender.
    - `loanAmountThreshold` object — Min and max loan amount the lender will process.
      - `minAmount` integer
      - `maxAmount` integer
    - `interestRate` number — Offered interest rate (%).
  - `message` string

---

[API](https://skmtc.net/smallcase/apis/graph-performance-api.md) · [All operations](https://skmtc.net/smallcase/apis/graph-performance-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smallcase/graph-performance-api/versions/6d2439eafede/schema)