Your open spreads
https://app.skylit.ai/api/nexus/v1/spreadsYour open multi-leg spreads on your main simulated account: each leg, its last mark, what you opened it for, what it makes at the marks, the collateral it holds and its exit plan. Read only: nothing here places, changes or closes a spread.
Spreads live on your main account only. Leave account and port out (or send account=main); anything else answers 422 port_unsupported.
You can read your open spreads whenever the desk shows them to you: while spreads are open to members, or while you still hold one. Otherwise the answer is 403 feature_disabled: spreads aren't open to you right now.
A figure that hasn't been measured is null, never 0: markPrice and unrealizedPnl stay null until every leg has a mark, and exit is null with no stop or target set.
curl -s "https://app.skylit.ai/api/nexus/v1/spreads" \
-H "Authorization: Bearer $SKYLIT_API_KEY"
Authorization
Authorization: Bearer <your API key>Required. A missing header returns 401; an invalid, revoked or expired key returns 403.
Query parameters
limitintegerdefault50min 1 · max 200How many to return, 1 to 200 (more is read as 200).
offsetintegerdefault0min 0How many to skip first.
accountstringmainor left out. Spreads are on your main account only.main
Responses
- 200
Your open spreads, by underlying and expiration.
- 400
bad_request: limit or offset out of range. - 401
Missing or invalid key.
- 403
feature_disabled: spreads are not open to you right now. - 422
port_unsupported: spreads are on your main account only. - 503
unavailable: spreads are not available on this server right now.
Response fields
dataobject[]requiredspreadIdstringuuidaccountstringmainstrategystringVERTICAL, IRON_CONDOR, BUTTERFLY, CALENDAR, DIAGONAL, COVERED_STOCK and the others the desk opens.
underlyingstringnetEffectstringHow it opened.
DEBITCREDITquantityintegeropenPricenumber | nullPer spread, a size (netEffect says which way).
markPricenumber | nullPer spread at the legs' marks; null until every leg has one.
unrealizedPnlnumber | nullDollars the held quantity makes at the marks; null with markPrice.
realizedPnlnumber | nullDollars partial closes already made.
collateralnumber | nullDollars set aside while it is held.
exitobjectlegsobject[]
metaobjectrequiredtotalintegerEvery row there is, across all pages.
limitintegeroffsetinteger
Last updated