API Reference

---

API Reference / Instrument

Interface: Instrument

Defined in: src/resources/Instruments.ts:5

A scrip-master row, normalized out of the segment CSV.

Properties

securityId

securityId: string

Defined in: src/resources/Instruments.ts:6

---

symbolName?

optional symbolName?: string

Defined in: src/resources/Instruments.ts:7

---

displayName?

optional displayName?: string

Defined in: src/resources/Instruments.ts:8

---

exchange?

optional exchange?: string

Defined in: src/resources/Instruments.ts:9

---

segment?

optional segment?: string

Defined in: src/resources/Instruments.ts:10

---

exchangeSegment?

optional exchangeSegment?: string

Defined in: src/resources/Instruments.ts:11

---

instrument?

optional instrument?: string

Defined in: src/resources/Instruments.ts:12

---

series?

optional series?: string

Defined in: src/resources/Instruments.ts:13

---

lotSize?

optional lotSize?: number

Defined in: src/resources/Instruments.ts:14

---

tickSize?

optional tickSize?: number

Defined in: src/resources/Instruments.ts:15

---

expiryDate?

optional expiryDate?: string

Defined in: src/resources/Instruments.ts:16

---

strikePrice?

optional strikePrice?: number

Defined in: src/resources/Instruments.ts:17

---

optionType?

optional optionType?: string

Defined in: src/resources/Instruments.ts:18

---

underlyingSymbol?

optional underlyingSymbol?: string

Defined in: src/resources/Instruments.ts:19

---

isin?

optional isin?: string

Defined in: src/resources/Instruments.ts:20

---

instrumentType?

optional instrumentType?: string

Defined in: src/resources/Instruments.ts:21

---

expiryFlag?

optional expiryFlag?: string

Defined in: src/resources/Instruments.ts:22

---

bracketFlag?

optional bracketFlag?: string

Defined in: src/resources/Instruments.ts:23

---

coverFlag?

optional coverFlag?: string

Defined in: src/resources/Instruments.ts:24

---

asmGsmFlag?

optional asmGsmFlag?: string

Defined in: src/resources/Instruments.ts:25

---

asmGsmCategory?

optional asmGsmCategory?: string

Defined in: src/resources/Instruments.ts:26

---

buySellIndicator?

optional buySellIndicator?: string

Defined in: src/resources/Instruments.ts:27

---

buyCoMinMarginPer?

optional buyCoMinMarginPer?: number

Defined in: src/resources/Instruments.ts:28

---

sellCoMinMarginPer?

optional sellCoMinMarginPer?: number

Defined in: src/resources/Instruments.ts:29

---

mtfLeverage?

optional mtfLeverage?: number

Defined in: src/resources/Instruments.ts:30