Ed25519 session-key request signing. Every authenticated request carries three headers: X-Monaco-PublicKey (64-char lowercase-hex session public key), X-Monaco-Timestamp (Unix milliseconds, within 30s of server time), and X-Monaco-Signature (hex ed25519 signature). The signature is over METHOD\npath?query\ntimestamp_ms\nSHA256_hex(body), where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from POST /api/v1/auth/challenge followed by POST /api/v1/auth/verify.
Sub-account key of the margin account whose risk bucket this names, like
marginAccountId (default is the default margin account). Refused when it is
not a valid sub-account key, names none of the caller's open sub-accounts, or
disagrees with marginAccountId.
Deprecated: accepted and ignored. Cross scope is the markets where the cross bucket has an open position, so a cross preview has nothing to declare: it runs against the account's active cross bucket — or the deterministic bucket a first cross order would create — and the previewed pair is in scope by construction. Rejected for ISOLATED, as before. The response's selectedTradingPairIds reports that scope plus the previewed pair, never this list.
MARKET only: client slippage tolerance in basis points, 0..1000, the same rule placement enforces — a LIMIT or IOC preview carrying it is rejected. Tightens the previewed walk to the band the real order will run under and never widens it; omit for the placement default.
The margin account the preview runs against: the default margin account
(the default) or any of the caller's open sub-accounts, previewing that
account's own risk buckets.
What this order pays in fees once its WHOLE size has executed, priced by
the role each part of it plays against the book right now: the taker rate
(plus the application's additional taker fee) on the quantity that would
cross immediately, and the maker rate on the quantity that would rest and
be filled later. Both rates are the caller's own tier-resolved rates. One
figure covers both cases — an order that crosses entirely, one that rests
entirely, and every split in between.
Signed: NEGATIVE means a net rebate, which is the honest answer for a
resting order on a pair whose maker fee is negative. Populated even when
accepted is false, and populated for reduce-only orders — closing a
position pays fees like any other fill.
It assumes the resting part eventually fills, so it states what the order
costs if it runs to completion, not a probability-weighted figure: cancel
before the remainder fills and only the crossing part was ever charged.
ABSENT — never zero — when the engine could not price the order: it was
refused before it could be matched, or its resolved maker tier exceeds the
pair's cap. Absence means unknown, so do not render it as a free order.
Estimated liquidation mark-price. In ISOLATED mode, this is the
position/risk-bucket threshold. In CROSS mode, it is conditional: it varies
only the target position's mark while all other marks in the cross risk
bucket remain unchanged. Other position marks, funding, realized PnL,
fees/reserves, and collateral can change it. Treat an absent or blank value
as unavailable, never as zero.
The cross scope the preview ran against; absent for isolated previews and
never a request's deprecated list: the markets where the active cross
bucket has an open position, sorted by trading pair id, then the previewed
pair when it is not already among them — the previewed pair alone when no
cross bucket is active yet.
The simulated match the engine ran to admit this order (0XM-2746): the
same MatchResult shape CreateOrderResponse.match_result carries for a
real placement, produced by the same simulate_match_with_stp walk over
the live book at the moment of the preview — under the caller's
slippage_tolerance_bps merged tighter-wins with the mandatory 1,000 bps
protective band, the caller's own self-trade-prevention default (the
preview runs under the caller's wallet, as placement does) and
reduce-only sizing. Not a handler-side re-walk of an orderbook snapshot,
so a preflight and the placement it precedes read the same numbers — the
reason this rides the risk simulation rather than a separate quote
endpoint. What a preview cannot carry: a post-only flag, TP/SL legs and a
per-order self-trade-prevention override, so a post-only placement that
would cross is refused by placement, not by this preview.
Fields: total_filled is what the walk fills; remaining_quantity what
it could NOT fill inside the merged band — the partial-fill / band-cut
indicator (0 means the whole size executes; a MARKET preview with a
non-zero remainder comes back partially filled when placed);
average_fill_price is the quantity-weighted fill price and
execution_price_range.worst_price the worst level reached (highest ask a
BUY takes, lowest bid a SELL hits), both absent when nothing crosses;
status is the status placement would end in: FILLED for a full fill,
CANCELLED for a MARKET order the band or the depth cuts short (a MARKET
remainder cannot rest, so the fills execute and the rest is cancelled —
read remaining_quantity for the partial fill), SUBMITTED for a LIMIT
that rests, PARTIALLY_FILLED for a LIMIT that crosses partly and rests
the remainder; actual_slippage_bps the realized
slippage against reference_price as the engine computes it for a
placement, absent when nothing crosses; max_slippage_bps echoes the
caller's tolerance, not the merged band. A LIMIT preview that would rest
reports 0 filled, the full size remaining and no prices.
For a LIMIT or IOC preview the engine measures slippage against the LIMIT
price and reports none when every fill improved on it, exactly as the
placement's match_result does; reference_price below is therefore
published for MARKET previews only.
Priced against the book RIGHT NOW. For a take-profit / stop-loss the close
runs later, on a different book, under the wider 1,200 bps band the engine
stamps on a triggered market leg and anchored at trigger time — so for a
TP/SL estimate apply actual_slippage_bps to the TRIGGER price as an
impact figure rather than displaying this call's absolute average price.
Fees for this walk are estimated_fee above, at the caller's own tier,
which can lag the engine's copy by one refresh interval.
PRESENT ONLY when accepted is true. Absent — never zeros — on every
refused preview (accepted: false with a reject_reason): validation, an
unknown market or account, insufficient margin, a maker-risk constraint, a
MARKET order with nothing fillable inside the band, and the post-match
maker-risk revalidation, whose match the engine discards. Such previews
may still carry estimated_fee, which is priced independently of risk
state. Treat absence as unknown, not as "fills at zero".
The touch on the taking side when a MARKET preview ran (best ask for a BUY, best bid for a SELL) — what expectedMatchResult's walk and its actualSlippageBps are measured from. Present only when accepted is true and the preview is a MARKET order; a LIMIT or IOC preview is measured against its own limit price and publishes nothing here.
Structured code of the refusal behind rejectReason, the same code placing the order would return in the error envelope (e.g. MARGIN_MODE_CONFLICT when the margin account holds the pair in its other margin mode; INVALID_ORDER for the catch-all). Present for client-class refusals; absent on an accepted preview, and absent when the preview failed on a server-side fault (rejectReason is then a generic retry message).
Example:
"MARGIN_MODE_CONFLICT"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Monaco Protocol SDK v1.1.14","description":"High-performance spot and perpetuals trading infrastructure built on Sei. Complete documentation for builders integrating Monaco Protocol into their applications.","colors":{"primary":"#233329","light":"#3A5544","dark":"#1A2620"},"logo":{"light":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=6b0d46b12348c8cb28126629f97faae0","dark":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo-white.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=2e00e628ed93f72b88edb25eb8d8725e"},"favicon":"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logoMark.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=7cfd00a92f26b8cb3855b908c31629b8","api":{"playground":{"proxy":false},"examples":{"prefill":true}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://0xmonaco.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"monaco","hasAudioNarration":false,"actualSubdomain":"monaco","customDomains":["docs.0xmonaco.com"],"gitSource":{"type":"github","owner":"monaco-research","repo":"monaco-core","deployBranch":"develop","contentDirectory":"docs/src","isPrivate":true,"mountPath":"","label":""},"feedback":{"issues":false,"edits":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5296f119781e823692a89","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"APIs","count":189},{"language":"default","tag":"REST API","count":166},{"language":"default","tag":"Libraries","count":27},{"language":"default","tag":"gRPC API","count":21},{"language":"default","tag":"Protobuf Reference","count":21},{"language":"default","tag":"Market","count":20},{"language":"default","tag":"TypeScript SDK","count":19},{"language":"default","tag":"Margin Accounts","count":19},{"language":"default","tag":"Orders","count":19},{"language":"default","tag":"Accounts","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk","slug":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk","pageMetadata":{"title":"Post apiv1marginrisk bucketssimulate order risk","description":null,"deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Post apiv1marginrisk bucketssimulate order risk","description":null,"deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["MarginAccountsService"],"operationId":"simulate_risk_bucket_order_risk","requestBody":"ed7f2e71-d135-4221-b04a-f2d5bba24972","responses":{"200":"c58e0be8-8ee0-47e8-b8f1-2defdeadc6d6","429":"216297d3-a818-4002-8ba5-74b61a1f1eac"},"security":["b395987a-caaf-4b2a-b6d8-351a5ed67e1c","9fe24d99-a13f-4336-aa2d-55c40680f634"],"method":"post","type":"path","servers":["76af5a68-1490-444f-9e1c-a0268868c659"],"path":"/api/v1/margin/risk-buckets/simulate-order-risk","baseUrlOptions":["https://apimonaco.xyz"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.tradingPairId.oneOf.0":"3c90c3cc-0d44-4b50-8888-8dd25736052a","body.strategyKey.oneOf.0":"\u003cstring>","body.side.oneOf.0":"\u003cstring>","body.positionSide.oneOf.0":"\u003cstring>","body.orderType.oneOf.0":"\u003cstring>","body.price.oneOf.0":"\u003cstring>","body.quantity.oneOf.0":"\u003cstring>","body.leverage.oneOf.0":"\u003cstring>","body.reduceOnly.oneOf.0":true,"body.marginMode.oneOf.0":"\u003cstring>","body.selectedTradingPairIds.oneOf.0.items.0":"3c90c3cc-0d44-4b50-8888-8dd25736052a","body.slippageToleranceBps.oneOf.0":123,"body.marginAccountId.oneOf.0":"\u003cstring>"}],"disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tradingPairId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"tradingPairId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"tradingPairId.oneOf.1","typeLabel":"null"}],"uniqueKey":"tradingPairId","typeLabel":"string\u003cuuid> | null"},"strategyKey":{"oneOf":[{"type":"string","description":"Sub-account key of the margin account whose risk bucket this names, like\n marginAccountId (`default` is the default margin account). Refused when it is\n not a valid sub-account key, names none of the caller's open sub-accounts, or\n disagrees with marginAccountId.","uniqueKey":"strategyKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sub-account key of the margin account whose risk bucket this names, like\n marginAccountId (`default` is the default margin account). Refused when it is\n not a valid sub-account key, names none of the caller's open sub-accounts, or\n disagrees with marginAccountId.","uniqueKey":"strategyKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"strategyKey","typeLabel":"string | null"},"side":{"oneOf":[{"type":"string","uniqueKey":"side.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"side.oneOf.1","typeLabel":"null"}],"uniqueKey":"side","typeLabel":"string | null"},"positionSide":{"oneOf":[{"type":"string","description":"Deprecated compatibility value; `side` is authoritative.","uniqueKey":"positionSide.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deprecated compatibility value; `side` is authoritative.","uniqueKey":"positionSide.oneOf.1","typeLabel":"null"}],"uniqueKey":"positionSide","typeLabel":"string | null"},"orderType":{"oneOf":[{"type":"string","uniqueKey":"orderType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"orderType.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderType","typeLabel":"string | null"},"price":{"oneOf":[{"type":"string","uniqueKey":"price.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"price.oneOf.1","typeLabel":"null"}],"uniqueKey":"price","typeLabel":"string | null"},"quantity":{"oneOf":[{"type":"string","uniqueKey":"quantity.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"quantity","typeLabel":"string | null"},"leverage":{"oneOf":[{"type":"string","description":"Required for normal orders; optional and ignored for reduce-only.","uniqueKey":"leverage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Required for normal orders; optional and ignored for reduce-only.","uniqueKey":"leverage.oneOf.1","typeLabel":"null"}],"uniqueKey":"leverage","typeLabel":"string | null"},"reduceOnly":{"oneOf":[{"type":"boolean","uniqueKey":"reduceOnly.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"reduceOnly.oneOf.1","typeLabel":"null"}],"uniqueKey":"reduceOnly","typeLabel":"boolean | null"},"marginMode":{"oneOf":[{"type":"string","description":"Risk bucket mode. Defaults to ISOLATED. Values: ISOLATED, CROSS.","uniqueKey":"marginMode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Risk bucket mode. Defaults to ISOLATED. Values: ISOLATED, CROSS.","uniqueKey":"marginMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"marginMode","typeLabel":"string | null"},"selectedTradingPairIds":{"oneOf":[{"deprecated":true,"type":"array","items":{"type":"string","minLength":1,"format":"uuid","uniqueKey":"selectedTradingPairIds.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Deprecated: accepted and ignored. Cross scope is the markets where the cross bucket has an open position, so a cross preview has nothing to declare: it runs against the account's active cross bucket — or the deterministic bucket a first cross order would create — and the previewed pair is in scope by construction. Rejected for ISOLATED, as before. The response's selectedTradingPairIds reports that scope plus the previewed pair, never this list.","uniqueKey":"selectedTradingPairIds.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"deprecated":true,"type":"null","items":{"type":"string","minLength":1,"format":"uuid"},"description":"Deprecated: accepted and ignored. Cross scope is the markets where the cross bucket has an open position, so a cross preview has nothing to declare: it runs against the account's active cross bucket — or the deterministic bucket a first cross order would create — and the previewed pair is in scope by construction. Rejected for ISOLATED, as before. The response's selectedTradingPairIds reports that scope plus the previewed pair, never this list.","uniqueKey":"selectedTradingPairIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"selectedTradingPairIds","typeLabel":"string\u003cuuid>[] | null"},"slippageToleranceBps":{"oneOf":[{"maximum":1000,"type":"integer","description":"MARKET only: client slippage tolerance in basis points, 0..1000, the same rule placement enforces — a LIMIT or IOC preview carrying it is rejected. Tightens the previewed walk to the band the real order will run under and never widens it; omit for the placement default.","format":"int32","uniqueKey":"slippageToleranceBps.oneOf.0","typeLabel":"integer\u003cint32>"},{"maximum":1000,"type":"null","description":"MARKET only: client slippage tolerance in basis points, 0..1000, the same rule placement enforces — a LIMIT or IOC preview carrying it is rejected. Tightens the previewed walk to the band the real order will run under and never widens it; omit for the placement default.","format":"int32","uniqueKey":"slippageToleranceBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"slippageToleranceBps","typeLabel":"integer\u003cint32> | null"},"marginAccountId":{"oneOf":[{"type":"string","description":"The margin account the preview runs against: the default margin account\n (the default) or any of the caller's open sub-accounts, previewing that\n account's own risk buckets.","uniqueKey":"marginAccountId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The margin account the preview runs against: the default margin account\n (the default) or any of the caller's open sub-accounts, previewing that\n account's own risk buckets.","uniqueKey":"marginAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"marginAccountId","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"tradingPairId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","strategyKey":"\u003cstring>","side":"\u003cstring>","positionSide":"\u003cstring>","orderType":"\u003cstring>","price":"\u003cstring>","quantity":"\u003cstring>","leverage":"\u003cstring>","reduceOnly":true,"marginMode":"\u003cstring>","selectedTradingPairIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"slippageToleranceBps":123,"marginAccountId":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"c58e0be8-8ee0-47e8-b8f1-2defdeadc6d6":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accepted":{"oneOf":[{"type":"boolean","uniqueKey":"accepted.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"accepted.oneOf.1","typeLabel":"null"}],"uniqueKey":"accepted","typeLabel":"boolean | null"},"rejectReason":{"oneOf":[{"type":"string","uniqueKey":"rejectReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"rejectReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"rejectReason","typeLabel":"string | null"},"equityAfter":{"oneOf":[{"type":"string","uniqueKey":"equityAfter.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"equityAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"equityAfter","typeLabel":"string | null"},"initialMarginRequiredAfter":{"oneOf":[{"type":"string","uniqueKey":"initialMarginRequiredAfter.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"initialMarginRequiredAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"initialMarginRequiredAfter","typeLabel":"string | null"},"maintenanceMarginRequiredAfter":{"oneOf":[{"type":"string","uniqueKey":"maintenanceMarginRequiredAfter.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"maintenanceMarginRequiredAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"maintenanceMarginRequiredAfter","typeLabel":"string | null"},"freeCollateralAfter":{"oneOf":[{"type":"string","uniqueKey":"freeCollateralAfter.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"freeCollateralAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"freeCollateralAfter","typeLabel":"string | null"},"estimatedFee":{"oneOf":[{"type":"string","description":"What this order pays in fees once its WHOLE size has executed, priced by\n the role each part of it plays against the book right now: the taker rate\n (plus the application's additional taker fee) on the quantity that would\n cross immediately, and the maker rate on the quantity that would rest and\n be filled later. Both rates are the caller's own tier-resolved rates. One\n figure covers both cases — an order that crosses entirely, one that rests\n entirely, and every split in between.\n\n Signed: NEGATIVE means a net rebate, which is the honest answer for a\n resting order on a pair whose maker fee is negative. Populated even when\n `accepted` is false, and populated for reduce-only orders — closing a\n position pays fees like any other fill.\n\n It assumes the resting part eventually fills, so it states what the order\n costs if it runs to completion, not a probability-weighted figure: cancel\n before the remainder fills and only the crossing part was ever charged.\n\n ABSENT — never zero — when the engine could not price the order: it was\n refused before it could be matched, or its resolved maker tier exceeds the\n pair's cap. Absence means unknown, so do not render it as a free order.","uniqueKey":"estimatedFee.oneOf.0","typeLabel":"string"},{"type":"null","description":"What this order pays in fees once its WHOLE size has executed, priced by\n the role each part of it plays against the book right now: the taker rate\n (plus the application's additional taker fee) on the quantity that would\n cross immediately, and the maker rate on the quantity that would rest and\n be filled later. Both rates are the caller's own tier-resolved rates. One\n figure covers both cases — an order that crosses entirely, one that rests\n entirely, and every split in between.\n\n Signed: NEGATIVE means a net rebate, which is the honest answer for a\n resting order on a pair whose maker fee is negative. Populated even when\n `accepted` is false, and populated for reduce-only orders — closing a\n position pays fees like any other fill.\n\n It assumes the resting part eventually fills, so it states what the order\n costs if it runs to completion, not a probability-weighted figure: cancel\n before the remainder fills and only the crossing part was ever charged.\n\n ABSENT — never zero — when the engine could not price the order: it was\n refused before it could be matched, or its resolved maker tier exceeds the\n pair's cap. Absence means unknown, so do not render it as a free order.","uniqueKey":"estimatedFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"estimatedFee","typeLabel":"string | null"},"estimatedLiquidationPrice":{"oneOf":[{"type":"string","description":"Estimated liquidation mark-price. In ISOLATED mode, this is the\n position/risk-bucket threshold. In CROSS mode, it is conditional: it varies\n only the target position's mark while all other marks in the cross risk\n bucket remain unchanged. Other position marks, funding, realized PnL,\n fees/reserves, and collateral can change it. Treat an absent or blank value\n as unavailable, never as zero.","uniqueKey":"estimatedLiquidationPrice.oneOf.0","typeLabel":"string"},{"type":"null","description":"Estimated liquidation mark-price. In ISOLATED mode, this is the\n position/risk-bucket threshold. In CROSS mode, it is conditional: it varies\n only the target position's mark while all other marks in the cross risk\n bucket remain unchanged. Other position marks, funding, realized PnL,\n fees/reserves, and collateral can change it. Treat an absent or blank value\n as unavailable, never as zero.","uniqueKey":"estimatedLiquidationPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"estimatedLiquidationPrice","typeLabel":"string | null"},"marginAccountId":{"oneOf":[{"type":"string","description":"The margin account the simulation was resolved against. Always populated;\n useful for auto-resolved buckets where the caller didn't supply the id.","uniqueKey":"marginAccountId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The margin account the simulation was resolved against. Always populated;\n useful for auto-resolved buckets where the caller didn't supply the id.","uniqueKey":"marginAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"marginAccountId","typeLabel":"string | null"},"strategyKey":{"oneOf":[{"type":"string","description":"The request's strategyKey (the sub-account key) on an isolated risk-bucket\n preview, `default` when it sent none.","uniqueKey":"strategyKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request's strategyKey (the sub-account key) on an isolated risk-bucket\n preview, `default` when it sent none.","uniqueKey":"strategyKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"strategyKey","typeLabel":"string | null"},"riskBucketId":{"oneOf":[{"type":"string","description":"Present when the simulation resolved against a risk bucket.","uniqueKey":"riskBucketId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when the simulation resolved against a risk bucket.","uniqueKey":"riskBucketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"riskBucketId","typeLabel":"string | null"},"marginMode":{"oneOf":[{"type":"string","description":"Present when the simulation resolved against a risk bucket. Values: ISOLATED, CROSS.","uniqueKey":"marginMode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when the simulation resolved against a risk bucket. Values: ISOLATED, CROSS.","uniqueKey":"marginMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"marginMode","typeLabel":"string | null"},"selectedTradingPairIds":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"format":"uuid","uniqueKey":"selectedTradingPairIds.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"The cross scope the preview ran against; absent for isolated previews and\n never a request's deprecated list: the markets where the active cross\n bucket has an open position, sorted by trading pair id, then the previewed\n pair when it is not already among them — the previewed pair alone when no\n cross bucket is active yet.","uniqueKey":"selectedTradingPairIds.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","minLength":1,"format":"uuid"},"description":"The cross scope the preview ran against; absent for isolated previews and\n never a request's deprecated list: the markets where the active cross\n bucket has an open position, sorted by trading pair id, then the previewed\n pair when it is not already among them — the previewed pair alone when no\n cross bucket is active yet.","uniqueKey":"selectedTradingPairIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"selectedTradingPairIds","typeLabel":"string\u003cuuid>[] | null"},"expectedMatchResult":{"oneOf":[{"type":"object","description":"The simulated match the engine ran to admit this order (0XM-2746): the\n same `MatchResult` shape `CreateOrderResponse.match_result` carries for a\n real placement, produced by the same `simulate_match_with_stp` walk over\n the live book at the moment of the preview — under the caller's\n `slippage_tolerance_bps` merged tighter-wins with the mandatory 1,000 bps\n protective band, the caller's own self-trade-prevention default (the\n preview runs under the caller's wallet, as placement does) and\n reduce-only sizing. Not a handler-side re-walk of an orderbook snapshot,\n so a preflight and the placement it precedes read the same numbers — the\n reason this rides the risk simulation rather than a separate quote\n endpoint. What a preview cannot carry: a post-only flag, TP/SL legs and a\n per-order self-trade-prevention override, so a post-only placement that\n would cross is refused by placement, not by this preview.\n\n Fields: `total_filled` is what the walk fills; `remaining_quantity` what\n it could NOT fill inside the merged band — the partial-fill / band-cut\n indicator (0 means the whole size executes; a MARKET preview with a\n non-zero remainder comes back partially filled when placed);\n `average_fill_price` is the quantity-weighted fill price and\n `execution_price_range.worst_price` the worst level reached (highest ask a\n BUY takes, lowest bid a SELL hits), both absent when nothing crosses;\n `status` is the status placement would end in: FILLED for a full fill,\n CANCELLED for a MARKET order the band or the depth cuts short (a MARKET\n remainder cannot rest, so the fills execute and the rest is cancelled —\n read `remaining_quantity` for the partial fill), SUBMITTED for a LIMIT\n that rests, PARTIALLY_FILLED for a LIMIT that crosses partly and rests\n the remainder; `actual_slippage_bps` the realized\n slippage against `reference_price` as the engine computes it for a\n placement, absent when nothing crosses; `max_slippage_bps` echoes the\n caller's tolerance, not the merged band. A LIMIT preview that would rest\n reports 0 filled, the full size remaining and no prices.\n\n For a LIMIT or IOC preview the engine measures slippage against the LIMIT\n price and reports none when every fill improved on it, exactly as the\n placement's `match_result` does; `reference_price` below is therefore\n published for MARKET previews only.\n\n Priced against the book RIGHT NOW. For a take-profit / stop-loss the close\n runs later, on a different book, under the wider 1,200 bps band the engine\n stamps on a triggered market leg and anchored at trigger time — so for a\n TP/SL estimate apply `actual_slippage_bps` to the TRIGGER price as an\n impact figure rather than displaying this call's absolute average price.\n Fees for this walk are `estimated_fee` above, at the caller's own tier,\n which can lag the engine's copy by one refresh interval.\n\n PRESENT ONLY when `accepted` is true. Absent — never zeros — on every\n refused preview (`accepted: false` with a `reject_reason`): validation, an\n unknown market or account, insufficient margin, a maker-risk constraint, a\n MARKET order with nothing fillable inside the band, and the post-match\n maker-risk revalidation, whose match the engine discards. Such previews\n may still carry `estimated_fee`, which is priced independently of risk\n state. Treat absence as unknown, not as \"fills at zero\".","properties":{"tradesCount":{"oneOf":[{"example":2,"type":"integer","description":"Number of trades generated by this order","format":"int32","uniqueKey":"expectedMatchResult.oneOf.0.tradesCount.oneOf.0","typeLabel":"integer\u003cint32>"},{"example":2,"type":"null","description":"Number of trades generated by this order","format":"int32","uniqueKey":"expectedMatchResult.oneOf.0.tradesCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.tradesCount","typeLabel":"integer\u003cint32> | null"},"totalFilled":{"oneOf":[{"example":"0.2","type":"string","description":"Total quantity filled","uniqueKey":"expectedMatchResult.oneOf.0.totalFilled.oneOf.0","typeLabel":"string"},{"example":"0.2","type":"null","description":"Total quantity filled","uniqueKey":"expectedMatchResult.oneOf.0.totalFilled.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.totalFilled","typeLabel":"string | null"},"remainingQuantity":{"oneOf":[{"example":"0.3","type":"string","description":"Remaining unfilled quantity","uniqueKey":"expectedMatchResult.oneOf.0.remainingQuantity.oneOf.0","typeLabel":"string"},{"example":"0.3","type":"null","description":"Remaining unfilled quantity","uniqueKey":"expectedMatchResult.oneOf.0.remainingQuantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.remainingQuantity","typeLabel":"string | null"},"averageFillPrice":{"oneOf":[{"example":"35100.00","type":"string","description":"Volume-weighted average fill price","uniqueKey":"expectedMatchResult.oneOf.0.averageFillPrice.oneOf.0","typeLabel":"string"},{"example":"35100.00","type":"null","description":"Volume-weighted average fill price","uniqueKey":"expectedMatchResult.oneOf.0.averageFillPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.averageFillPrice","typeLabel":"string | null"},"status":{"oneOf":[{"example":"PARTIALLY_FILLED","type":"string","description":"Resulting order status after matching","uniqueKey":"expectedMatchResult.oneOf.0.status.oneOf.0","typeLabel":"string"},{"example":"PARTIALLY_FILLED","type":"null","description":"Resulting order status after matching","uniqueKey":"expectedMatchResult.oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.status","typeLabel":"string | null"},"actualSlippageBps":{"oneOf":[{"example":15,"type":"integer","description":"Actual slippage incurred in basis points","format":"int32","uniqueKey":"expectedMatchResult.oneOf.0.actualSlippageBps.oneOf.0","typeLabel":"integer\u003cint32>"},{"example":15,"type":"null","description":"Actual slippage incurred in basis points","format":"int32","uniqueKey":"expectedMatchResult.oneOf.0.actualSlippageBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.actualSlippageBps","typeLabel":"integer\u003cint32> | null"},"maxSlippageBps":{"oneOf":[{"example":50,"type":"integer","description":"Maximum slippage tolerance that was set","format":"int32","uniqueKey":"expectedMatchResult.oneOf.0.maxSlippageBps.oneOf.0","typeLabel":"integer\u003cint32>"},{"example":50,"type":"null","description":"Maximum slippage tolerance that was set","format":"int32","uniqueKey":"expectedMatchResult.oneOf.0.maxSlippageBps.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.maxSlippageBps","typeLabel":"integer\u003cint32> | null"},"executionPriceRange":{"type":"object","properties":{"bestPrice":{"oneOf":[{"example":"2045.00","type":"string","description":"Best execution price achieved","uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange.bestPrice.oneOf.0","typeLabel":"string"},{"example":"2045.00","type":"null","description":"Best execution price achieved","uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange.bestPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange.bestPrice","typeLabel":"string | null"},"worstPrice":{"oneOf":[{"example":"2052.00","type":"string","description":"Worst execution price in the fill","uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange.worstPrice.oneOf.0","typeLabel":"string"},{"example":"2052.00","type":"null","description":"Worst execution price in the fill","uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange.worstPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange.worstPrice","typeLabel":"string | null"}},"uniqueKey":"expectedMatchResult.oneOf.0.executionPriceRange","typeLabel":"object"}},"uniqueKey":"expectedMatchResult.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"expectedMatchResult.oneOf.1","typeLabel":"null"}],"uniqueKey":"expectedMatchResult","typeLabel":"object | null"},"referencePrice":{"oneOf":[{"example":"100.25","type":"string","description":"The touch on the taking side when a MARKET preview ran (best ask for a BUY, best bid for a SELL) — what expectedMatchResult's walk and its actualSlippageBps are measured from. Present only when accepted is true and the preview is a MARKET order; a LIMIT or IOC preview is measured against its own limit price and publishes nothing here.","uniqueKey":"referencePrice.oneOf.0","typeLabel":"string"},{"example":"100.25","type":"null","description":"The touch on the taking side when a MARKET preview ran (best ask for a BUY, best bid for a SELL) — what expectedMatchResult's walk and its actualSlippageBps are measured from. Present only when accepted is true and the preview is a MARKET order; a LIMIT or IOC preview is measured against its own limit price and publishes nothing here.","uniqueKey":"referencePrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"referencePrice","typeLabel":"string | null"},"rejectCode":{"oneOf":[{"example":"MARGIN_MODE_CONFLICT","type":"string","description":"Structured code of the refusal behind rejectReason, the same code placing the order would return in the error envelope (e.g. MARGIN_MODE_CONFLICT when the margin account holds the pair in its other margin mode; INVALID_ORDER for the catch-all). Present for client-class refusals; absent on an accepted preview, and absent when the preview failed on a server-side fault (rejectReason is then a generic retry message).","uniqueKey":"rejectCode.oneOf.0","typeLabel":"string"},{"example":"MARGIN_MODE_CONFLICT","type":"null","description":"Structured code of the refusal behind rejectReason, the same code placing the order would return in the error envelope (e.g. MARGIN_MODE_CONFLICT when the margin account holds the pair in its other margin mode; INVALID_ORDER for the catch-all). Present for client-class refusals; absent on an accepted preview, and absent when the preview failed on a server-side fault (rejectReason is then a generic retry message).","uniqueKey":"rejectCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"rejectCode","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accepted":true,"rejectReason":"\u003cstring>","equityAfter":"\u003cstring>","initialMarginRequiredAfter":"\u003cstring>","maintenanceMarginRequiredAfter":"\u003cstring>","freeCollateralAfter":"\u003cstring>","estimatedFee":"\u003cstring>","estimatedLiquidationPrice":"\u003cstring>","marginAccountId":"\u003cstring>","strategyKey":"\u003cstring>","riskBucketId":"\u003cstring>","marginMode":"\u003cstring>","selectedTradingPairIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"expectedMatchResult":{"tradesCount":2,"totalFilled":"0.2","remainingQuantity":"0.3","averageFillPrice":"35100.00","status":"PARTIALLY_FILLED","actualSlippageBps":15,"maxSlippageBps":50,"executionPriceRange":{"bestPrice":"2045.00","worstPrice":"2052.00"}},"referencePrice":"100.25","rejectCode":"MARGIN_MODE_CONFLICT"}}},"exampleType":"generated"}},"exampleType":"generated"},"216297d3-a818-4002-8ba5-74b61a1f1eac":{"description":"Read rate limit exceeded — every authenticated read draws one request from the account's read budget; retry after the interval in details.retryAfter","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"b395987a-caaf-4b2a-b6d8-351a5ed67e1c":{"monacoSignature":{"type":"apiKey","description":"Ed25519 session-key request signing. Every authenticated request carries three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of server time), and `X-Monaco-Signature` (hex ed25519 signature). The signature is over `METHOD\\npath?query\\ntimestamp_ms\\nSHA256_hex(body)`, where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from `POST /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.","name":"X-Monaco-Signature","in":"header","scopes":[],"schemeName":"monacoSignature"}},"9fe24d99-a13f-4336-aa2d-55c40680f634":{"monacoHttpSignature":{"type":"apiKey","description":"RFC 9421 Ed25519 session-key request signatures. Send Signature-Input, Signature, and Content-Digest together; never combine them with X-Monaco-* credentials. The monaco signature covers @method, @path, @query, and content-digest in that order, with created (Unix seconds within 30s of server time), keyid (registered lowercase-hex session public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530 sha-256 over the exact body bytes, including the empty body. Query coverage retains ordering and percent encoding. Timestamp freshness does not reject repeated identical requests; use endpoint idempotency where supported. Existing legacy signing remains supported during server-first migration; SDK RFC 9421 signing is opt-in. See https://docs.0xmonaco.com/reference/http-message-signatures for the complete profile and trust model.","name":"Signature","in":"header","scopes":[],"schemeName":"monacoHttpSignature"}}},"servers":{"76af5a68-1490-444f-9e1c-a0268868c659":{"url":"https://apimonaco.xyz","description":"Production (Sei mainnet)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Ed25519 session-key request signing. Every authenticated request carries three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of server time), and `X-Monaco-Signature` (hex ed25519 signature). The signature is over `METHOD\\npath?query\\ntimestamp_ms\\nSHA256_hex(body)`, where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from `POST /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.","name":"X-Monaco-Signature","in":"header","scopes":[],"schemeName":"monacoSignature"},"schema":{"title":"X-Monaco-Signature","type":"string","description":"Ed25519 session-key request signing. Every authenticated request carries three headers: `X-Monaco-PublicKey` (64-char lowercase-hex session public key), `X-Monaco-Timestamp` (Unix milliseconds, within 30s of server time), and `X-Monaco-Signature` (hex ed25519 signature). The signature is over `METHOD\\npath?query\\ntimestamp_ms\\nSHA256_hex(body)`, where the body hash is the SHA-256 of the empty byte string when there is no body. Obtain the session keypair from `POST /api/v1/auth/challenge` followed by `POST /api/v1/auth/verify`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"monacoSignature","name":"X-Monaco-Signature"}],"title":"monacoSignature"},{"schemes":[{"scheme":{"type":"apiKey","description":"RFC 9421 Ed25519 session-key request signatures. Send Signature-Input, Signature, and Content-Digest together; never combine them with X-Monaco-* credentials. The monaco signature covers @method, @path, @query, and content-digest in that order, with created (Unix seconds within 30s of server time), keyid (registered lowercase-hex session public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530 sha-256 over the exact body bytes, including the empty body. Query coverage retains ordering and percent encoding. Timestamp freshness does not reject repeated identical requests; use endpoint idempotency where supported. Existing legacy signing remains supported during server-first migration; SDK RFC 9421 signing is opt-in. See https://docs.0xmonaco.com/reference/http-message-signatures for the complete profile and trust model.","name":"Signature","in":"header","scopes":[],"schemeName":"monacoHttpSignature"},"schema":{"title":"Signature","type":"string","description":"RFC 9421 Ed25519 session-key request signatures. Send Signature-Input, Signature, and Content-Digest together; never combine them with X-Monaco-* credentials. The monaco signature covers @method, @path, @query, and content-digest in that order, with created (Unix seconds within 30s of server time), keyid (registered lowercase-hex session public key), and alg=ed25519 parameters. Content-Digest uses RFC 9530 sha-256 over the exact body bytes, including the empty body. Query coverage retains ordering and percent encoding. Timestamp freshness does not reject repeated identical requests; use endpoint idempotency where supported. Existing legacy signing remains supported during server-first migration; SDK RFC 9421 signing is opt-in. See https://docs.0xmonaco.com/reference/http-message-signatures for the complete profile and trust model.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"monacoHttpSignature","name":"Signature"}],"title":"monacoHttpSignature"}]},"originalFileLocation":"proto-openapi/api/openapi.yaml"},"subdomain":"monaco","siteName":"Monaco Protocol SDK v1.1.14","title":"Post apiv1marginrisk bucketssimulate order risk - Monaco Protocol SDK v1.1.14","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T02:50:32.033Z","originalFileLocation":"api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Post apiv1marginrisk bucketssimulate order risk - Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://monaco.mintlify.site/_mintlify/api/og/v2?division=Margin+Accounts\u0026amp;title=Post+apiv1marginrisk+bucketssimulate+order+risk\u0026amp;theme=86c8539ecb88515b97c26589\u0026amp;signature=1f31f19615f8d5698c5655afeca3fe3e1719ffe78957ae32a1de2a23a30ec035\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Post apiv1marginrisk bucketssimulate order risk - Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://monaco.mintlify.site/_mintlify/api/og/v2?division=Margin+Accounts\u0026amp;title=Post+apiv1marginrisk+bucketssimulate+order+risk\u0026amp;theme=86c8539ecb88515b97c26589\u0026amp;signature=1f31f19615f8d5698c5655afeca3fe3e1719ffe78957ae32a1de2a23a30ec035\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/monaco/4wZNikyT1wBLArhB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Monaco Protocol SDK v1.1.14\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#233329\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.0xmonaco.com/#organization\",\"name\":\"Monaco Protocol SDK v1.1.14\",\"url\":\"https://docs.0xmonaco.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/monaco/Puhxf4Whf6wQMalZ/logo.png?fit=max\u0026auto=format\u0026n=Puhxf4Whf6wQMalZ\u0026q=85\u0026s=6b0d46b12348c8cb28126629f97faae0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.0xmonaco.com#website\",\"name\":\"Monaco Protocol SDK v1.1.14\",\"url\":\"https://docs.0xmonaco.com\",\"publisher\":{\"@id\":\"https://docs.0xmonaco.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk#webpage\",\"url\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk\",\"name\":\"Post apiv1marginrisk bucketssimulate order risk\",\"dateModified\":\"2026-11-12T02:50:32.033Z\",\"isPartOf\":{\"@id\":\"https://docs.0xmonaco.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.0xmonaco.com/api-reference/healthservice/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API\",\"item\":\"https://docs.0xmonaco.com/api-reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Margin Accounts\",\"item\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/get-apiv1marginaccounts\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Post apiv1marginrisk bucketssimulate order risk\",\"item\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk#apireference\",\"headline\":\"Post apiv1marginrisk bucketssimulate order risk\",\"name\":\"Post apiv1marginrisk bucketssimulate order risk\",\"url\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk\",\"mainEntityOfPage\":{\"@id\":\"https://docs.0xmonaco.com/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk#webpage\"},\"dateModified\":\"2026-11-12T02:50:32.033Z\",\"publisher\":{\"@id\":\"https://docs.0xmonaco.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.0xmonaco.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Monaco Protocol SDK v1.1.14\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Monaco Protocol SDK v1.1.14\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk.md","siteName":"Monaco Protocol SDK v1.1.14","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://0xmonaco.com"}]},"pages":[{"title":"Introduction","href":"/introduction"},{"title":"Markets","href":"/markets"},{"title":"AI \u0026 Agents","href":"/build-with-ai"},{"group":"Learn","pages":[{"title":"Accounts","href":"/accounts"},{"title":"Orders","href":"/trading-mechanics/spot"},{"title":"Margin","href":"/trading-mechanics/perps"},{"title":"Funding Rates","href":"/trading-mechanics/funding-rates"},{"title":"Liquidations \u0026 Auto-Deleveraging","href":"/trading-mechanics/liquidations"},{"title":"Fees","href":"/fees"},{"title":"Earn","href":"/earn"}]},{"group":"Build","pages":[{"title":"Quickstart","href":"/quickstart"},{"title":"Testnet","href":"/testnet"},{"title":"Wallets \u0026 Auth","href":"/developers/accounts/wallets"},{"title":"Balances, Deposits \u0026 Withdrawals","href":"/developers/vault"},{"title":"Perps Collateral","href":"/developers/perps-collateral"},{"title":"Market Data","href":"/developers/markets"},{"title":"Order Management","href":"/developers/trade"},{"title":"Rate Limits","href":"/developers/rate-limits"},{"title":"Positions","href":"/developers/positions"},{"title":"Market-Maker Runbook","href":"/developers/market-maker-runbook"},{"title":"RFQ (block trades)","href":"/developers/rfq"},{"title":"Delegated Agents","href":"/developers/delegated-agents"},{"title":"Invite Codes","href":"/developers/invite-codes"},{"title":"TraderCodes","href":"/developers/tradercodes"},{"title":"BuilderCodes","href":"/developers/buildercodes"}]},{"group":"Libraries","pages":[{"title":"MCP Server","href":"/sdk/mcp-server"},{"group":"TypeScript SDK","root":{"title":"TypeScript SDK","href":"/sdk/typescript/intro"},"expanded":false,"pages":[{"title":"Applications","href":"/sdk/typescript/applications"},{"title":"Authentication","href":"/sdk/typescript/auth"},{"title":"Error Handling","href":"/sdk/typescript/error-handling"},{"title":"Market Data","href":"/sdk/typescript/market"},{"title":"Market Pulse","href":"/sdk/typescript/pulse"},{"title":"Region Status","href":"/sdk/typescript/compliance"},{"title":"Analytics","href":"/sdk/typescript/analytics"},{"title":"Profile","href":"/sdk/typescript/profile"},{"title":"Portfolio Analytics","href":"/sdk/typescript/portfolio"},{"title":"Trading","href":"/sdk/typescript/trades"},{"title":"RFQ","href":"/sdk/typescript/rfq"},{"title":"Margin Accounts","href":"/sdk/typescript/margin-accounts"},{"title":"Positions","href":"/sdk/typescript/positions"},{"title":"Delegated Agents","href":"/sdk/typescript/delegated-agents"},{"title":"Vault","href":"/sdk/typescript/vault"},{"title":"TraderCodes","href":"/sdk/typescript/tradercodes"},{"title":"BuilderCodes","href":"/sdk/typescript/buildercodes"},{"title":"Managed Markets","href":"/sdk/typescript/managed-markets"},{"title":"WebSockets","href":"/sdk/typescript/websockets"}]},{"group":"React SDK","root":{"title":"React SDK","href":"/sdk/react/intro"},"expanded":false,"pages":[{"title":"Session \u0026 Profile Hooks","href":"/sdk/react/hooks/session"},{"title":"Market Data Hooks","href":"/sdk/react/hooks/market-data"},{"title":"Trading Hooks","href":"/sdk/react/hooks/trading"},{"title":"Balance \u0026 Vault Hooks","href":"/sdk/react/hooks/balances"},{"title":"TraderCodes Hooks","href":"/sdk/react/hooks/codes"}]},{"title":"Rust SDK","href":"/sdk/rust"},{"title":"Python, Go, C++ \u0026 More","href":"/sdk/python-quickstart"}]},{"group":"APIs","pages":[{"group":"REST API","root":{"title":"REST API","href":"/api-reference"},"expanded":false,"pages":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /health","href":"/api-reference/healthservice/health-check"}]},{"group":"Auth","pages":[{"title":"Create authentication challenge","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/challenge","href":"/api-reference/authservice/create-authentication-challenge"},{"title":"Verify signature and authenticate","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/verify","href":"/api-reference/authservice/verify-signature-and-authenticate"},{"title":"Mint one Mainnet invite code","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/invite-codes/requests","href":"/api-reference/authservice/mint-one-mainnet-invite-code"},{"title":"List my Mainnet invite codes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/invite-codes","href":"/api-reference/authservice/list-my-mainnet-invite-codes"},{"title":"Refresh session expiry","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/refresh","href":"/api-reference/authservice/refresh-session-expiry"},{"title":"Revoke current session","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/auth/revoke","href":"/api-reference/authservice/revoke-current-session"}]},{"group":"Accounts","pages":[{"title":"Get user profile","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me","href":"/api-reference/accountsservice/get-user-profile"},{"title":"Get user balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/balances","href":"/api-reference/accountsservice/get-user-balances"},{"title":"Get user balance by asset","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/balances/{assetId}","href":"/api-reference/accountsservice/get-user-balance-by-asset"},{"title":"Get user movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/movements","href":"/api-reference/accountsservice/get-user-movements"},{"title":"Get user trade history","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/trades","href":"/api-reference/accountsservice/get-user-trade-history"},{"title":"Get portfolio stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio","href":"/api-reference/accountsservice/get-portfolio-stats"},{"title":"Get portfolio chart time series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/chart","href":"/api-reference/accountsservice/get-portfolio-chart-time-series"},{"title":"Get portfolio summary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/summary","href":"/api-reference/accountsservice/get-portfolio-summary"},{"title":"Get portfolio performance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/performance","href":"/api-reference/accountsservice/get-portfolio-performance"},{"title":"Get portfolio realized PnL","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/realized-pnl","href":"/api-reference/accountsservice/get-portfolio-realized-pnl"},{"title":"Get portfolio assets","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/assets","href":"/api-reference/accountsservice/get-portfolio-assets"},{"title":"Get portfolio margin","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/me/portfolio/margin","href":"/api-reference/accountsservice/get-portfolio-margin"},{"title":"List funding payments","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/funding-payments","href":"/api-reference/accountsservice/list-funding-payments"},{"title":"List sub-accounts with balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/sub-accounts","href":"/api-reference/accountsservice/list-sub-accounts-with-balances"},{"title":"Get your self-trade-prevention default","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/self-trade-prevention","href":"/api-reference/accountsservice/get-your-self-trade-prevention-default"},{"title":"Set your self-trade-prevention default","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/accounts/self-trade-prevention","href":"/api-reference/accountsservice/set-your-self-trade-prevention-default"}]},{"group":"Account Limits","pages":[{"title":"Create sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/accounts/sub-accounts/limits","href":"/api-reference/accountsservice/create-sub-account-limit"},{"title":"Get sub-account limits","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/accounts/sub-accounts/{subAccountId}/limits","href":"/api-reference/accountsservice/get-sub-account-limits"},{"title":"Update sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/accounts/sub-accounts/{subAccountId}/limits/{assetId}","href":"/api-reference/accountsservice/update-sub-account-limit"},{"title":"Delete sub-account limit","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/accounts/sub-accounts/{subAccountId}/limits/{assetId}","href":"/api-reference/accountsservice/delete-sub-account-limit"}]},{"group":"Applications","pages":[{"title":"Get application configuration","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/config","href":"/api-reference/applicationsservice/get-application-configuration"},{"title":"Get application stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/stats","href":"/api-reference/applicationsservice/get-application-stats"},{"title":"List application users","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/users","href":"/api-reference/applicationsservice/list-application-users"},{"title":"List application balances","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/balances","href":"/api-reference/applicationsservice/list-application-balances"},{"title":"List application margin accounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/margin-accounts","href":"/api-reference/applicationsservice/list-application-margin-accounts"},{"title":"List application orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/orders","href":"/api-reference/applicationsservice/list-application-orders"},{"title":"List application movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/applications/movements","href":"/api-reference/applicationsservice/list-application-movements"}]},{"group":"Market","pages":[{"title":"Trading Pairs","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs","href":"/api-reference/marketservice/trading-pairs"},{"title":"Trading Pair By ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}","href":"/api-reference/marketservice/trading-pair-by-id"},{"title":"Market Metadata","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/metadata","href":"/api-reference/marketservice/market-metadata"},{"title":"Get apiv1marketpairs perpconfig","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/perp/config","href":"/api-reference/marketservice/get-apiv1marketpairs-perpconfig"},{"title":"Get apiv1marketpairs perpsummary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/perp/summary","href":"/api-reference/marketservice/get-apiv1marketpairs-perpsummary"},{"title":"Get apiv1marketpairs mark price","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/mark-price","href":"/api-reference/marketservice/get-apiv1marketpairs-mark-price"},{"title":"Get apiv1marketpairs index price","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/index-price","href":"/api-reference/marketservice/get-apiv1marketpairs-index-price"},{"title":"Get apiv1marketpairs funding","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/funding","href":"/api-reference/marketservice/get-apiv1marketpairs-funding"},{"title":"Get apiv1marketpairs fundinghistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/funding/history","href":"/api-reference/marketservice/get-apiv1marketpairs-fundinghistory"},{"title":"Get apiv1marketfundinghistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/funding/history","href":"/api-reference/marketservice/get-apiv1marketfundinghistory"},{"title":"Open Interest","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/open-interest","href":"/api-reference/marketservice/open-interest"},{"title":"Trader Metrics","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/trader-metrics","href":"/api-reference/marketservice/trader-metrics"},{"title":"Trade Flow","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/trade-flow","href":"/api-reference/marketservice/trade-flow"},{"title":"Liquidation Events","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-events","href":"/api-reference/marketservice/liquidation-events"},{"title":"All Liquidation Events","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/liquidation-events","href":"/api-reference/marketservice/all-liquidation-events"},{"title":"Insurance Funds","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/insurance-funds","href":"/api-reference/marketservice/insurance-funds"},{"title":"Liquidation Metrics","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/{tradingPairId}/liquidation-metrics","href":"/api-reference/marketservice/liquidation-metrics"},{"title":"Candlestick Data","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/pairs/charts/candlestick/{tradingPairId}/{interval}","href":"/api-reference/marketservice/candlestick-data"},{"title":"Market Stats","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/stats","href":"/api-reference/marketservice/market-stats"},{"title":"Market Screener","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/market/screener","href":"/api-reference/marketservice/market-screener"}]},{"group":"Orderbook","pages":[{"title":"Orderbook Snapshot","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orderbook/{tradingPairId}","href":"/api-reference/orderbookservice/orderbook-snapshot"}]},{"group":"Trades","pages":[{"title":"Trade Feed","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades","href":"/api-reference/tradesservice/trade-feed"},{"title":"Recent Trades","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades/{tradingPairId}","href":"/api-reference/tradesservice/recent-trades"},{"title":"Get Trade by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/trades/by-id/{tradeId}","href":"/api-reference/tradesservice/get-trade-by-id"}]},{"group":"RFQ","pages":[{"title":"Get RFQ capabilities","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/rfq/capabilities","href":"/api-reference/rfqservice/get-rfq-capabilities"},{"title":"Request quotes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs","href":"/api-reference/rfqservice/request-quotes"},{"title":"List your RFQs","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/rfqs","href":"/api-reference/rfqservice/list-your-rfqs"},{"title":"Get an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/rfqs/{rfqId}","href":"/api-reference/rfqservice/get-an-rfq"},{"title":"Accept an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs/{rfqId}/accept","href":"/api-reference/rfqservice/accept-an-rfq"},{"title":"Cancel an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs/{rfqId}/cancel","href":"/api-reference/rfqservice/cancel-an-rfq"},{"title":"Quote an RFQ","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/rfqs/{rfqId}/quote","href":"/api-reference/rfqservice/quote-an-rfq"},{"title":"Withdraw a quote","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/rfqs/{rfqId}/quote","href":"/api-reference/rfqservice/withdraw-a-quote"},{"title":"Answer last look","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/rfqs/{rfqId}/last-look","href":"/api-reference/rfqservice/answer-last-look"}]},{"group":"Fees","pages":[{"title":"Simulate fees for a potential order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/simulate","href":"/api-reference/feesservice/simulate-fees-for-a-potential-order"},{"title":"Get my fee tier and pair schedule","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/tier","href":"/api-reference/feesservice/get-my-fee-tier-and-pair-schedule"},{"title":"Get a trading pair's fee tier schedule","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/fees/schedule","href":"/api-reference/feesservice/get-a-trading-pairs-fee-tier-schedule"}]},{"group":"Withdrawals","pages":[{"title":"Initiate withdrawal","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/withdrawals","href":"/api-reference/withdrawalsservice/initiate-withdrawal"},{"title":"List pending withdrawals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/withdrawals","href":"/api-reference/withdrawalsservice/list-pending-withdrawals"},{"title":"Get withdrawal","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/withdrawals/{withdrawalIndex}","href":"/api-reference/withdrawalsservice/get-withdrawal"}]},{"group":"Analytics","pages":[{"title":"Protocol totals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/protocol/totals","href":"/api-reference/analyticsservice/protocol-totals"},{"title":"Protocol series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/protocol/series","href":"/api-reference/analyticsservice/protocol-series"},{"title":"Market volumes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/markets/volume","href":"/api-reference/analyticsservice/market-volumes"},{"title":"Treasury net fees","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/treasury/net-fees","href":"/api-reference/analyticsservice/treasury-net-fees"},{"title":"Builders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders","href":"/api-reference/analyticsservice/builders"},{"title":"Builder","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders/{builder}","href":"/api-reference/analyticsservice/builder"},{"title":"Builder totals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders/{builder}/totals","href":"/api-reference/analyticsservice/builder-totals"},{"title":"Builder series","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builders/{builder}/series","href":"/api-reference/analyticsservice/builder-series"},{"title":"Builder leaderboard","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/builder-leaderboard","href":"/api-reference/analyticsservice/builder-leaderboard"},{"title":"Wallet leaderboard","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/wallet-leaderboard","href":"/api-reference/analyticsservice/wallet-leaderboard"},{"title":"Wallet summary","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/wallets/{wallet}","href":"/api-reference/analyticsservice/wallet-summary"},{"title":"Wallet liquidations","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/wallets/{wallet}/liquidations","href":"/api-reference/analyticsservice/wallet-liquidations"},{"title":"Token custody","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/tokens","href":"/api-reference/analyticsservice/token-custody"},{"title":"Token custody detail","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/tokens/{token}","href":"/api-reference/analyticsservice/token-custody-detail"},{"title":"Vault deposits","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/deposits","href":"/api-reference/analyticsservice/vault-deposits"},{"title":"Vault withdrawals","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/analytics/withdrawals","href":"/api-reference/analyticsservice/vault-withdrawals"}]},{"group":"Pulse","pages":[{"title":"Get the market pulse news feed","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/pulse","href":"/api-reference/pulseservice/get-the-market-pulse-news-feed"}]},{"group":"Compliance","pages":[{"title":"Get the caller's region status","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/compliance/region","href":"/api-reference/complianceservice/get-the-callers-region-status"}]},{"group":"Sweeper","pages":[{"title":"Register a deposit address for monitoring","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/sweeper/register","href":"/api-reference/sweeperservice/register-a-deposit-address-for-monitoring"},{"title":"List the chains and assets the sweeper watches","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/chains","href":"/api-reference/sweeperservice/list-the-chains-and-assets-the-sweeper-watches"},{"title":"List the caller's sweeper deposits, newest first","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits","href":"/api-reference/sweeperservice/list-the-callers-sweeper-deposits-newest-first"},{"title":"Get the status of the caller's deposit from Hyperliquid by its action nonce","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits/hypercore/{nonce}","href":"/api-reference/sweeperservice/get-the-status-of-the-callers-deposit-from-hyperliquid-by-its-action-nonce"},{"title":"Get the status of the caller's sweeper deposits in one transaction","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/sweeper/deposits/{txHash}","href":"/api-reference/sweeperservice/get-the-status-of-the-callers-sweeper-deposits-in-one-transaction"}]},{"group":"Managed Markets","pages":[{"title":"List caller managed market assignments","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/managed-markets/assignments","href":"/api-reference/managedmarketsservice/list-caller-managed-market-assignments"},{"title":"Claim or renew a fenced maker lease","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/managed-markets/{launchId}/lease","href":"/api-reference/managedmarketsservice/claim-or-renew-a-fenced-maker-lease"},{"title":"Refresh the server-bounded managed quote set","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/managed-markets/{launchId}/quotes","href":"/api-reference/managedmarketsservice/refresh-the-server-bounded-managed-quote-set"}]},{"group":"Orders","pages":[{"title":"Get user orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders","href":"/api-reference/ordersservice/get-user-orders"},{"title":"Create new order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders","href":"/api-reference/ordersservice/create-new-order"},{"title":"Get order by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/{orderId}","href":"/api-reference/ordersservice/get-order-by-id"},{"title":"Replace existing order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/orders/{orderId}","href":"/api-reference/ordersservice/replace-existing-order"},{"title":"Cancel existing order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/cancel","href":"/api-reference/ordersservice/cancel-existing-order"},{"title":"Batch cancel specific orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel","href":"/api-reference/ordersservice/batch-cancel-specific-orders"},{"title":"Batch create orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-create","href":"/api-reference/ordersservice/batch-create-orders"},{"title":"Batch replace orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-replace","href":"/api-reference/ordersservice/batch-replace-orders"},{"title":"Cancel all orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel-all","href":"/api-reference/ordersservice/cancel-all-orders"},{"title":"Cancel all orders for a trading pair","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/batch-cancel-all/{tradingPairId}","href":"/api-reference/ordersservice/cancel-all-orders-for-a-trading-pair"},{"title":"Cancel all orders after a timeout","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/cancel-all-after","href":"/api-reference/ordersservice/cancel-all-orders-after-a-timeout"},{"title":"Get apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/get-apiv1ordersconditional"},{"title":"Get apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/get-apiv1ordersconditional"},{"title":"Delete apiv1ordersconditional","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/orders/conditional/{conditionalOrderId}","href":"/api-reference/ordersservice/delete-apiv1ordersconditional"},{"title":"Create TWAP order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/twap","href":"/api-reference/ordersservice/create-twap-order"},{"title":"List TWAP orders","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap","href":"/api-reference/ordersservice/list-twap-orders"},{"title":"Get TWAP order by ID","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}","href":"/api-reference/ordersservice/get-twap-order-by-id"},{"title":"Get TWAP order TCA report","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}/tca","href":"/api-reference/ordersservice/get-twap-order-tca-report"},{"title":"List TWAP order slices","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/orders/twap/{twapOrderId}/slices","href":"/api-reference/ordersservice/list-twap-order-slices"},{"title":"Cancel TWAP order","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/orders/twap/{twapOrderId}/cancel","href":"/api-reference/ordersservice/cancel-twap-order"}]},{"group":"Margin Accounts","pages":[{"title":"Get apiv1marginaccounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts"},{"title":"Get apiv1marginaccounts","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts"},{"title":"Post apiv1marginaccounts collateraltransfer in","deprecated":true,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-collateraltransfer-in"},{"title":"Post apiv1marginaccounts collateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-collateraltransfer-out"},{"title":"Get apiv1marginaccounts movements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}/movements","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts-movements"},{"title":"Get apiv1marginaccounts pnl","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/accounts/{marginAccountId}/pnl","href":"/api-reference/marginaccountsservice/get-apiv1marginaccounts-pnl"},{"title":"Post apiv1marginaccounts simulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/accounts/{marginAccountId}/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginaccounts-simulate-order-risk"},{"title":"Get apiv1margincollateralavailable","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/collateral/available","href":"/api-reference/marginaccountsservice/get-apiv1margincollateralavailable"},{"title":"Post apiv1margincollateraltransfer","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/collateral/transfer","href":"/api-reference/marginaccountsservice/post-apiv1margincollateraltransfer"},{"title":"Get apiv1marginparent margin account","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/parent-margin-account","href":"/api-reference/marginaccountsservice/get-apiv1marginparent-margin-account"},{"title":"Post apiv1marginparent margin accountcollateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountcollateraltransfer-in"},{"title":"Post apiv1marginparent margin accountcollateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountcollateraltransfer-out"},{"title":"Get apiv1marginparent margin accountmovements","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/margin/parent-margin-account/movements","href":"/api-reference/marginaccountsservice/get-apiv1marginparent-margin-accountmovements"},{"title":"Post apiv1marginparent margin accountsimulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/parent-margin-account/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginparent-margin-accountsimulate-order-risk"},{"title":"Post apiv1marginrisk bucketscollateraltransfer in","description":"Fund a risk bucket from the parent margin account's unallocated\n collateral (no wallet movement; the bucket is created if needed). Since\n 0XM-2632, funding an ISOLATED bucket that holds an open position also\n credits that position's stored margin — the same behavior as the\n deprecated `TransferCollateralToMarginAccount` Adjust Margin rail — so\n adding collateral to support a position has one behavior on every route.\n A flat isolated bucket and the cross bucket stay plain allocations.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketscollateraltransfer-in"},{"title":"Post apiv1marginrisk bucketssimulate order risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/risk-buckets/simulate-order-risk","href":"/api-reference/marginaccountsservice/post-apiv1marginrisk-bucketssimulate-order-risk"},{"title":"Post apiv1marginsub accounts","description":"Open a sub-account: another margin account of the caller, keyed by\n `subaccount_key`, with its own collateral and its own risk buckets. The\n default margin account (key `default`) is the only one deposits and\n withdrawals touch; fund a sub-account with `TransferCollateral`.\n Re-creating the key of a closed sub-account re-opens the same account.\n Keys starting with `copy:` are reserved. An owner may hold a limited\n number of open sub-accounts, set by their weighted 14-day volume tier\n (10 at the first tier, up to 50) or an admin override; a create past it\n is refused. Copy-trading sub-accounts do not count.","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts"},{"title":"Post apiv1marginsub accounts close","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/close","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-close"},{"title":"Post apiv1marginsub accounts collateraltransfer in","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/collateral/transfer-in","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-collateraltransfer-in"},{"title":"Post apiv1marginsub accounts collateraltransfer out","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/margin/sub-accounts/{marginAccountId}/collateral/transfer-out","href":"/api-reference/marginaccountsservice/post-apiv1marginsub-accounts-collateraltransfer-out"}]},{"group":"Positions","pages":[{"title":"Get apiv1positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}","href":"/api-reference/positionsservice/get-apiv1positions"},{"title":"Get apiv1positionshistory","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/history","href":"/api-reference/positionsservice/get-apiv1positionshistory"},{"title":"Post apiv1positionsbatch close all","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/batch-close-all","href":"/api-reference/positionsservice/post-apiv1positionsbatch-close-all"},{"title":"Get apiv1positions","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}","href":"/api-reference/positionsservice/get-apiv1positions"},{"title":"Post apiv1positions close","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/{positionId}/close","href":"/api-reference/positionsservice/post-apiv1positions-close"},{"title":"Get position PnL history","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/pnl/history","href":"/api-reference/positionsservice/get-position-pnl-history"},{"title":"Get apiv1positions risk","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/positions/{positionId}/risk","href":"/api-reference/positionsservice/get-apiv1positions-risk"},{"title":"Post apiv1positions tp sl","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/positions/{positionId}/tp-sl","href":"/api-reference/positionsservice/post-apiv1positions-tp-sl"}]},{"group":"Delegated Agents","pages":[{"title":"Upsert delegated agent","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/delegated-agents","href":"/api-reference/delegatedagentsservice/upsert-delegated-agent"},{"title":"List delegated agents","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/delegated-agents","href":"/api-reference/delegatedagentsservice/list-delegated-agents"},{"title":"List delegating owners","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/delegated-agents/owners","href":"/api-reference/delegatedagentsservice/list-delegating-owners"},{"title":"Revoke delegated agent","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/delegated-agents/{delegatedAgentId}","href":"/api-reference/delegatedagentsservice/revoke-delegated-agent"},{"title":"Create delegated session","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/delegated-agents/sessions","href":"/api-reference/delegatedagentsservice/create-delegated-session"}]},{"group":"TraderCodes","pages":[{"title":"Get your TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/me","href":"/api-reference/tradercodeservice/get-your-tradercode"},{"title":"Check custom TraderCode availability","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/available","href":"/api-reference/tradercodeservice/check-custom-tradercode-availability"},{"title":"Look up a TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/codes/{code}","href":"/api-reference/tradercodeservice/look-up-a-tradercode"},{"title":"Claim or edit your custom TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/tradercodes/codes/me/custom","href":"/api-reference/tradercodeservice/claim-or-edit-your-custom-tradercode"},{"title":"Clear your custom TraderCode","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml delete /api/v1/tradercodes/codes/me/custom","href":"/api-reference/tradercodeservice/clear-your-custom-tradercode"},{"title":"Get your referral position","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me","href":"/api-reference/tradercodeservice/get-your-referral-position"},{"title":"Get your referral downline and earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me/downline","href":"/api-reference/tradercodeservice/get-your-referral-downline-and-earnings"},{"title":"Get one level of your referral tree","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/referrals/me/tree","href":"/api-reference/tradercodeservice/get-one-level-of-your-referral-tree"},{"title":"Get your rewards balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/tradercodes/rewards/balance","href":"/api-reference/tradercodeservice/get-your-rewards-balance"},{"title":"Transfer rewards into a trading balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/tradercodes/rewards/transfer","href":"/api-reference/tradercodeservice/transfer-rewards-into-a-trading-balance"}]},{"group":"BuilderCodes","pages":[{"title":"Get your BuilderCodes program configuration","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/config","href":"/api-reference/buildercoderewardsservice/get-your-buildercodes-program-configuration"},{"title":"Set your builder fees","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml put /api/v1/buildercodes/builder-fee","href":"/api-reference/buildercoderewardsservice/set-your-builder-fees"},{"title":"List your builder-fee changes","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/builder-fee/changes","href":"/api-reference/buildercoderewardsservice/list-your-builder-fee-changes"},{"title":"List your per-trade BuilderCodes earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/payouts","href":"/api-reference/buildercoderewardsservice/list-your-per-trade-buildercodes-earnings"},{"title":"Summarize your BuilderCodes earnings","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/payouts/summary","href":"/api-reference/buildercoderewardsservice/summarize-your-buildercodes-earnings"},{"title":"Get your accrued BuilderCodes balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml get /api/v1/buildercodes/rewards/balance","href":"/api-reference/buildercoderewardsservice/get-your-accrued-buildercodes-balance"},{"title":"Claim accrued BuilderCodes payout balance","deprecated":null,"version":null,"openapi":"/proto-openapi/api/openapi.yaml post /api/v1/buildercodes/rewards/claim","href":"/api-reference/buildercoderewardsservice/claim-accrued-buildercodes-payout-balance"}]}]},{"title":"WebSocket API","href":"/reference/websockets"},{"title":"HTTP message signatures","href":"/reference/http-message-signatures"},{"group":"gRPC API","root":{"title":"gRPC API","href":"/reference/grpc"},"expanded":false,"pages":[{"group":"Protobuf Reference","root":{"title":"Protobuf Reference","href":"/grpc/protos"},"expanded":false,"pages":[{"group":"Core","pages":[{"title":"AuthService","href":"/grpc/protos/auth"},{"title":"AccountsService","href":"/grpc/protos/accounts"},{"title":"ApplicationsService","href":"/grpc/protos/applications"},{"title":"HealthService","href":"/grpc/protos/health"},{"title":"ComplianceService","href":"/grpc/protos/compliance"}]},{"group":"Trading","pages":[{"title":"MarketService","href":"/grpc/protos/market"},{"title":"AnalyticsService","href":"/grpc/protos/analytics"},{"title":"PulseService","href":"/grpc/protos/pulse"},{"title":"OrdersService","href":"/grpc/protos/orders"},{"title":"OrderbookService","href":"/grpc/protos/orderbook"},{"title":"TradesService","href":"/grpc/protos/trades"},{"title":"FeesService","href":"/grpc/protos/fees"},{"title":"RfqService","href":"/grpc/protos/rfq"}]},{"group":"Perps","pages":[{"title":"MarginAccountsService","href":"/grpc/protos/margin-accounts"},{"title":"PositionsService","href":"/grpc/protos/positions"}]},{"group":"Vault and Delegation","pages":[{"title":"WithdrawalsService","href":"/grpc/protos/withdrawals"},{"title":"SweeperService","href":"/grpc/protos/sweeper"},{"title":"DelegatedAgentsService","href":"/grpc/protos/delegated-agents"}]},{"group":"TraderCodes","pages":[{"title":"TraderCodeService","href":"/grpc/protos/tradercodes"}]},{"group":"BuilderCodes","pages":[{"title":"BuildercodeRewardsService","href":"/grpc/protos/buildercodes"}]},{"group":"Managed Markets","pages":[{"title":"ManagedMarketsService","href":"/grpc/protos/managed-markets"}]}]}]}]},{"group":"Resources","pages":[{"title":null,"href":"/changelog"},{"group":"Examples","expanded":false,"pages":[{"title":"Build a Trading App","href":"/examples/build-trading-app"},{"title":"End-to-End Examples","href":"/examples/end-to-end"}]}]}]},"basePath":"","title":"Post apiv1marginrisk bucketssimulate order risk - Monaco Protocol SDK v1.1.14","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}