Error
A valid request URL is required to generate request examples{
"version": "external-order-preview/v1",
"accountId": "<string>",
"marketId": "<string>",
"side": "buy",
"orderType": "limit",
"quantityAtoms": "<string>",
"quantity": "<string>",
"notionalAtoms": "<string>",
"notional": "<string>",
"estimatedEntryPriceAtoms": "<string>",
"estimatedEntryPrice": "<string>",
"estimatedSlippageBps": 1,
"wouldExceedMaxSlippage": true,
"requiredMarginAtoms": "<string>",
"requiredMargin": "<string>",
"estimatedFeeAtoms": "<string>",
"estimatedFee": "<string>",
"feeRole": "maker",
"estimatedLiquidationPriceAtoms": "<string>",
"estimatedLiquidationPrice": "<string>",
"maintenanceMarginBps": 1,
"availableForOrdersAtoms": "<string>",
"availableForOrders": "<string>",
"sufficient": true,
"asOf": {
"markPriceAtoms": "<string>",
"markPrice": "<string>",
"journalSequence": 1
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}Orders
Preview an order
Computes estimated entry price, slippage, margin, fees, and liquidation price without reserving or journaling state.
Method and path: POST /v1/orders/preview
Authentication: DFNS trader bearer required.
Request schema: ExternalOrderPreviewRequest.
Response schema: ExternalOrderPreviewResponse.
Error envelope: ExternalRestError (external-rest-error/v1).
POST
/
v1
/
orders
/
preview
Error
A valid request URL is required to generate request examples{
"version": "external-order-preview/v1",
"accountId": "<string>",
"marketId": "<string>",
"side": "buy",
"orderType": "limit",
"quantityAtoms": "<string>",
"quantity": "<string>",
"notionalAtoms": "<string>",
"notional": "<string>",
"estimatedEntryPriceAtoms": "<string>",
"estimatedEntryPrice": "<string>",
"estimatedSlippageBps": 1,
"wouldExceedMaxSlippage": true,
"requiredMarginAtoms": "<string>",
"requiredMargin": "<string>",
"estimatedFeeAtoms": "<string>",
"estimatedFee": "<string>",
"feeRole": "maker",
"estimatedLiquidationPriceAtoms": "<string>",
"estimatedLiquidationPrice": "<string>",
"maintenanceMarginBps": 1,
"availableForOrdersAtoms": "<string>",
"availableForOrders": "<string>",
"sufficient": true,
"asOf": {
"markPriceAtoms": "<string>",
"markPrice": "<string>",
"journalSequence": 1
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
- Option 1
- Option 2
Minimum string length:
1Minimum string length:
1Available options:
buy, sell Allowed value:
"market"Required range:
x >= 1Pattern:
^[1-9][0-9]*$Pattern:
^[1-9][0-9]*$Response
Success
Allowed value:
"external-order-preview/v1"Minimum string length:
1Minimum string length:
1Available options:
buy, sell Available options:
limit, market Pattern:
^[1-9][0-9]*$Pattern:
^-?[0-9]+\.[0-9]+$Pattern:
^[1-9][0-9]*$Pattern:
^-?[0-9]+\.[0-9]+$Pattern:
^[1-9][0-9]*$Pattern:
^-?[0-9]+\.[0-9]+$Required range:
x >= 0Pattern:
^[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Pattern:
^[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Available options:
maker, taker Pattern:
^[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Required range:
x >= 0Pattern:
^[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Show child attributes
Show child attributes