Common Definition
This page lists the contract conventions and enum values used by Stock Option Trading endpoints.
Global rule: REST enum string values are UPPERCASE on both request and response, except the
settlement event status, which is always Completed. eventType filter values are
case-insensitive. The user data stream uses lowercase values (see
WebSocket Streams General Info).
Contract Symbol
symbol is always the OCC option contract symbol, formatted as
{root}{yymmdd}{C|P}{strike × 1000, zero-padded to 8 digits}. For example, NVDA260930C00100000 is
an NVDA call expiring on 2026-09-30 with a strike of 100.
Do not parse the OCC symbol to derive the underlying. After a corporate action, the root of an
adjusted contract carries a suffix (GOOG1 is not GOOG), so parsing would return the wrong stock.
Read underlyingSymbol, expirationDate, contractType, strikePrice and multiplier from the
response instead.
Contract Discovery
Browse contracts of an underlying in two steps:
GET /market/expirations— list the expiration dates of the underlying.GET /market/contracts— list all calls and puts of the underlying for one expiration date.
The expirationDate returned by step 1 can be passed as-is to step 2 (both use YYYY-MM-DD).
The returned symbol can then be used for order placement and Option Exchange Info.
When standard and corporate-action-adjusted contracts share an expiration date, step 1 returns
multiple rows with the same expirationDate and different rootSymbol. To list the adjusted
set, pass that rootSymbol to step 2; without it, only standard contracts are returned.
status
Contract trading status, returned by Option Contracts and Option Exchange Info. The values match the ones used by server-side order validation.
| Value | Description | Allowed positionIntent |
|---|---|---|
OPEN_CLOSE | Opening and closing allowed | BUY_TO_OPEN / SELL_TO_CLOSE / SELL_TO_OPEN / BUY_TO_CLOSE |
CLOSE_ONLY | Only reducing or closing existing positions | SELL_TO_CLOSE / BUY_TO_CLOSE |
NONE | No new orders allowed (delisted or suspended) | None |
statusis a snapshot at query time. The server-side validation at order placement is final.- Known deviation:
statusdoes not take the expiration-day time window into account. After the close on the expiration day, and during roughly the last 45 minutes before that close,statusmay still beOPEN_CLOSEwhile the order is rejected. The deviation is always on the optimistic side: a contract shown as not tradable is never actually tradable. statusreflects the contract only. Account-level restrictions (insufficient options level, restricted account, etc.) are returned as order error codes.statusapplies to orders, not to exercise. Use Exercisable Options to check whether an exercise can be submitted.- Mapping to order errors: with
status=NONE, orders return497426or497425; withstatus=CLOSE_ONLY, opening orders return497427; withstatus=OPEN_CLOSE, opening orders in roughly the last 45 minutes of the expiration day still return497423; for a contract with anystatus, orders placed after the close on the expiration day return497425.
positionIntent
| Value | Description | Position side |
|---|---|---|
BUY_TO_OPEN | Buy to open | Long |
SELL_TO_CLOSE | Sell to close | Long |
SELL_TO_OPEN | Sell to open (covered call / cash-secured put) | Short |
BUY_TO_CLOSE | Buy to close | Short |
positionIntentmay be omitted; the server derives it fromside:BUY→BUY_TO_OPEN,SELL→SELL_TO_CLOSE. The order is rejected (parameter error) if it is omitted when:side=BUYand the account holds a short position in the contract (it may be meant asBUY_TO_CLOSE);side=SELLand the account holds no long position in the contract (it can only beSELL_TO_OPEN).
- Therefore always pass the short side (
SELL_TO_OPEN/BUY_TO_CLOSE) explicitly. An explicit value must matchside(BUY_*withBUY,SELL_*withSELL); otherwise the order is rejected.
side
| Value | Description |
|---|---|
BUY | Buy |
SELL | Sell |
timeInForce
| Value | Description |
|---|---|
DAY | Good until the end of the trading day. The only value supported |
walletType
Used on Place Option Order. Optional; defaults to CARD.
| Value | Description |
|---|---|
CARD | Funding wallet (default) |
MAIN | Spot wallet |
Position side
Returned as side by Option Positions.
| Value | Description |
|---|---|
LONG | Long position |
SHORT | Short position |
Exercise status
| Value | Description |
|---|---|
PROCESSING | Submitted, in progress |
SUCCESS | Exercise completed |
FAILED | Exercise failed |
eventType
Used by the settlement event endpoints.
| Value | Description |
|---|---|
EXERCISE | Exercise of a long position |
ASSIGNMENT | Assignment of a short position |
EXPIRY | Contract expired without exercise |
settlementKind
| Value | Description |
|---|---|
PHYSICAL | Physical delivery |
CASH | Cash settlement |
MIXED | Both physical and cash |
cashDirection
| Value | Description |
|---|---|
DEBIT | Cash debited |
CREDIT | Cash credited |
Deliverable type
In Option Exchange Info and Exercisable Options, deliverables[].type is:
| Value | Description |
|---|---|
EQUITY | Shares; symbol is the ticker, amount is the share count |
CASH | Cash; symbol is the currency, amount is the cash amount |
In the settlement event endpoints, the share leg of deliverables has no type, and the cash leg
has one of:
| Value | Description |
|---|---|
OPEXC | Exercise cash |
OPASN | Assignment cash |
OPCSH | Cash settlement |