# Limits

## GET /api/oms/limits

Limits

to get the limits

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| Authorization | header | string | Yes | Access token in the following format:  Bearer <api_key>:<access_token>  Both values are required. The `api_key` is your app credential from the Apps Section. The `access_token` is obtained from the authentication endpoint and is valid for 24 hours. |

### Responses

#### 200 — OK

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| s | string ("ok" | "no-data" | "error") | No |  |
| d | object | No |  |
| d.totalCredits | number | No | Total credits is sum of availableCash, payIn, , adHocMargin, unclearedCash, brokerCollateralAmt,stockCollateral and auxCollateral |
| d.availMargin | number | No | Available margin is calculated by ( totalcredits - marginused ) |
| d.brokerage | number | No | Brokerage amount |
| d.availCash | number | No | Cash Margin available |
| d.peakMargin | number | No | Peak margin used by the user |
| d.payIn | number | No | Total Amount transferred using Payin's today |
| d.span | number | No | Span used |
| d.realizedPnl | number | No | Current realized PnL |
| d.unrealizedPnL | number | No | Unrealized PnL |
| d.exposure | number | No | Exposure margin |
| d.adHocMargin | number | No | Additional leverage amount or the amount added to handle system errors - by broker. |
| d.stockCollateral | number | No | Collateral amount calculated based on uploaded holdings |
| d.optionPremium | number | No | Derivative Margin |
| d.segment | string | No | Segment |
| d.payOut | number | No | Total amount requested for withdrawal today |
| d.brkCollatAmount | number | No | Broker Collateral Amount |
| d.unclearedCash | number | No | Uncleared Cash |
| d.auxCash | number | No | Aux day Cash |
| d.auxCollatAmount | number | No |  |
| d.auxUnclearedCash | number | No |  |
| d.dayCash | number | No | Additional leverage amount or the amount added to handle system errors - by broker. |
| d.turnOverLmt | number | No |  |
| d.pendOrdValLmt | number | No |  |
| d.turnover | number | No | Turnover |
| d.pendOrdValue | number | No | Pending Order value |
| d.marginUsed | number | No | Total margin or total fund used today |
| d.premium | number | No | Premium used |
| d.brokerageDerivativesBO | number | No | Brokerage Derivative Bracket Order |
| d.brokerageDerivativesMargin | number | No | Brokerage Derivative Margin |
| d.optPremiumDerMarg | number | No | Option premium Derivative Margin |
| msg | string ("no-data" | "error msg") | No |  |
| s | string ("ok" | "error" | "no-data") | No |  |

#### 401 — Unauthorized — one of: (1) invalid or expired access token — tokens expire after 24 hours, re-authenticate to get a new one; (2) `Authorization` header missing or malformed — use format `Bearer <api_key>:<access_token>`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| s | string ("error") | No | Response status. Always `error` for error responses. |
| msg | string ("Unauthorized") | No | Error message. |

#### 429 — Too Many Requests — rate limit exceeded. General API: 10 req/sec per auth token (400 req/min).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| s | string ("error") | No | Response status. Always `error` for error responses. |
| msg | string | No | Error message indicating the rate limit was exceeded. |

#### 500 — Internal Server Error — retry with backoff; contact support if it persists.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| s | string ("error") | No | Response status. Always `error` for error responses. |
| msg | string | No | Error message. |