enums

Table of contents

Type aliases

• ChartInterval
• ContingencyType
• LIMIT_MAKER_ORDER
• LIMIT_ORDER
• Limit
• MARKET_ORDER
• OCOOrderStatus
• OCOStatus
• ORDERS
• OrderResponseType
• OrderSide
• OrderStatus
• OrderType
• RAW_REQUESTS
• REQUEST_WEIGHT
• RateLimitType
• STOP_LOSS_LIMIT_ORDER
• STOP_LOSS_ORDER
• SymbolStatus
• SymbolType
• TAKE_PROFIT_LIMIT_ORDER
• TAKE_PROFIT_ORDER
• TimeInForce

Type aliases

ChartInterval

Ƭ ChartInterval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "2h" | "4h" | "6h" | "8h" | "12h" | "1d" | "3d" | "1w" | "1M"

m -> minutes; h -> hours; d -> days; w -> weeks; M -> months

Defined in: types/enums.ts:50

---

ContingencyType

Ƭ ContingencyType: "OCO"

Defined in: types/enums.ts:11

---

LIMIT_MAKER_ORDER

Ƭ LIMIT_MAKER_ORDER: "LIMIT_MAKER"

Defined in: types/enums.ts:25

---

LIMIT_ORDER

Ƭ LIMIT_ORDER: "LIMIT"

Defined in: types/enums.ts:13

---

Limit

Ƭ Limit: 5 | 10 | 20 | 50 | 100 | 500 | 1000 | 5000

Defined in: types/enums.ts:47

---

MARKET_ORDER

Ƭ MARKET_ORDER: "MARKET"

Defined in: types/enums.ts:15

---

OCOOrderStatus

Ƭ OCOOrderStatus: "EXECUTING" | "ALL_DONE" | "REJECT"

Defined in: types/enums.ts:9

---

OCOStatus

Ƭ OCOStatus: "RESPONSE" | "EXEC_STARTED" | "ALL_DONE"

Defined in: types/enums.ts:7

---

ORDERS

Ƭ ORDERS: object

Type declaration:

Name	Type
interval	"SECOND"
intervalNum	1
limit	10
rateLimitType	"ORDERS"

Defined in: types/enums.ts:59

---

OrderResponseType

Ƭ OrderResponseType: "ACK" | "RESULT" | "FULL"

Defined in: types/enums.ts:29

---

OrderSide

Ƭ OrderSide: "BUY" | "SELL"

Defined in: types/enums.ts:31

---

OrderStatus

Ƭ OrderStatus: "NEW" | "PARTIALLY_FILLED" | "FILLED" | "FILLED" | "CANCELLED" | "PENDING_CANCEL" | "REJECTED" | "EXPIRED"

Defined in: types/enums.ts:5

---

OrderType

Ƭ OrderType: LIMIT_ORDER | MARKET_ORDER | STOP_LOSS_ORDER | STOP_LOSS_LIMIT_ORDER | TAKE_PROFIT_ORDER | TAKE_PROFIT_LIMIT_ORDER | LIMIT_MAKER_ORDER

Defined in: types/enums.ts:27

---

RAW_REQUESTS

Ƭ RAW_REQUESTS: object

Type declaration:

Name	Type
interval	"MINUTE"
intervalNum	5
limit	500
rateLimitType	"RAW_REQUESTS"

Defined in: types/enums.ts:66

---

REQUEST_WEIGHT

Ƭ REQUEST_WEIGHT: object

Type declaration:

Name	Type
interval	"MINUTE"
intervalNum	1
limit	1200
rateLimitType	"REQUEST_WEIGHT"

Defined in: types/enums.ts:52

---

RateLimitType

Ƭ RateLimitType: REQUEST_WEIGHT | ORDERS | RAW_REQUESTS

Defined in: types/enums.ts:73

---

STOP_LOSS_LIMIT_ORDER

Ƭ STOP_LOSS_LIMIT_ORDER: "STOP_LOSS_LIMIT"

Defined in: types/enums.ts:19

---

STOP_LOSS_ORDER

Ƭ STOP_LOSS_ORDER: "STOP_LOSS"

Defined in: types/enums.ts:17

---

SymbolStatus

Ƭ SymbolStatus: "PRE_TRADING" | "TRADING" | "POST_TRADING" | "END_OF_DAY" | "HALT" | "AUCTION_MATCH" | "BREAK"

Defined in: types/enums.ts:1

---

SymbolType

Ƭ SymbolType: "SPOT"

Defined in: types/enums.ts:3

---

TAKE_PROFIT_LIMIT_ORDER

Ƭ TAKE_PROFIT_LIMIT_ORDER: "TAKE_PROFIT_LIMIT"

Defined in: types/enums.ts:23

---

TAKE_PROFIT_ORDER

Ƭ TAKE_PROFIT_ORDER: "TAKE_PROFIT"

Defined in: types/enums.ts:21

---

TimeInForce

Ƭ TimeInForce: "GTC" | "IOC" | "FOK"

This sets how long an order will be active before expiration.

Good Til Canceled: An order will be on the book unless the order is canceled.

Immediate Or Cancel: An order will try to fill the order as much as it can before the order expires.

Fill or Kill: An order will expire if the full order cannot be filled upon execution.

Defined in: types/enums.ts:45