SDK Enums Reference

These enums are exported from @trade-it/react so you can build trade configs with typed values instead of hardcoded strings.

import {
  LegType,
  OrderDirection,
  OrderType,
  PositionEffect,
  TimeInForce,
  TradeAction,
  TradeLinkParam,
  TradeType,
  TradeUnit,
} from '@trade-it/react';

TradeType

Used to choose simple vs options/multi-leg trade mode.

Enum member	Value	Meaning
TradeType.Simple	0	Simple buy/sell trade
TradeType.MultiLeg	1	Options / multi-leg trade

TradeAction

Used for simple trades and option legs.

Enum member	Value	Meaning
TradeAction.Buy	buy	Buy
TradeAction.Sell	sell	Sell

TradeUnit

Used for simple trade amount.

Enum member	Value	Meaning
TradeUnit.Dollars	dollars	Amount is in dollars
TradeUnit.Shares	shares	Amount is in shares

OrderType

Used for both simple and options trades.

Enum member	Value	Meaning
OrderType.Market	market	Execute at market price
OrderType.Limit	limit	Execute at limit price or better
OrderType.Stop	stop	Trigger at stop price
OrderType.StopLimit	stop_limit	Trigger at stop price, then submit limit order

TimeInForce

How long an order remains active.

Enum member	Value	Meaning
TimeInForce.Day	day	End of trading day
TimeInForce.GoodTillCanceled	gtc	Good til canceled
TimeInForce.ImmediateOrCancel	ioc	Immediate or cancel
TimeInForce.FillOrKill	fok	Fill or kill

LegType

Used in options/multi-leg legs[].

Enum member	Value	Meaning
LegType.Option	option	Options contract leg
LegType.Equity	equity	Equity/stock leg

PositionEffect

Used in options legs to indicate whether the trade opens or closes a position.

Enum member	Value	Meaning
PositionEffect.Open	open	Open a position
PositionEffect.Close	close	Close a position

OrderDirection

Primarily used in options pricing/context (net debit vs net credit).

Enum member	Value	Meaning
OrderDirection.Debit	debit	Net debit
OrderDirection.Credit	credit	Net credit

TradeLinkParam

Advanced enum that maps to the short query keys used by Trade Links and Trade It URL parsing.

You usually do not need this when using the React SDK, but it can be helpful for debugging or hybrid Trade Link + SDK integrations.

Enum member	Value	Meaning
TradeLinkParam.TradeType	tt	Trade type
TradeLinkParam.Action	t	Trade action
TradeLinkParam.OrderType	ot	Order type
TradeLinkParam.Amount	a	Trade amount
TradeLinkParam.Unit	u	Trade unit
TradeLinkParam.LimitPrice	lp	Limit price
TradeLinkParam.StopPrice	sp	Stop price
TradeLinkParam.TimeInForce	tif	Time in force
TradeLinkParam.UtmReferred	ref	Referral tag
TradeLinkParam.Legs	legs	Options legs payload