Error
A valid request URL is required to generate request examples{
"version": "external-account-snapshot/v1",
"accountId": "<string>",
"asset": "<string>",
"snapshotSequence": 1,
"readModelDigest": "<string>",
"marginMode": "isolated",
"cashBalanceAtoms": "<string>",
"cashBalance": "<string>",
"equityAtoms": "<string>",
"equity": "<string>",
"availableForOrdersAtoms": "<string>",
"availableForOrders": "<string>",
"resync": {
"stream": "account.margin",
"fromSequence": 123
},
"riskEvidence": {
"status": "complete"
}
}{
"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"
}Accounts
Get an account snapshot
Returns the account snapshot (balances, margin, equity) for an account.
Method and path: GET /v1/accounts/
Authentication: DFNS trader bearer required.
Request schema: none.
Response schema: ExternalAccountSnapshotResponse.
Error envelope: ExternalRestError (external-rest-error/v1).
GET
/
v1
/
accounts
/
{accountId}
Error
A valid request URL is required to generate request examples{
"version": "external-account-snapshot/v1",
"accountId": "<string>",
"asset": "<string>",
"snapshotSequence": 1,
"readModelDigest": "<string>",
"marginMode": "isolated",
"cashBalanceAtoms": "<string>",
"cashBalance": "<string>",
"equityAtoms": "<string>",
"equity": "<string>",
"availableForOrdersAtoms": "<string>",
"availableForOrders": "<string>",
"resync": {
"stream": "account.margin",
"fromSequence": 123
},
"riskEvidence": {
"status": "complete"
}
}{
"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.
Path Parameters
Minimum string length:
1Response
Success
Allowed value:
"external-account-snapshot/v1"Minimum string length:
1Minimum string length:
1Required range:
x >= 0Covers the engine account view this response was built from, before decimal formatting. Not recomputable from the formatted payload.
Pattern:
^sha256:[0-9a-f]{64}$Available options:
isolated, cross Pattern:
^[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Pattern:
^-?[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Pattern:
^[0-9]+$Pattern:
^-?[0-9]+\.[0-9]+$Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes