A valid request URL is required to generate request examples{
"account": "<string>",
"snapshot": {
"generatedAt": "2023-11-07T05:31:56Z",
"streamCursor": "<string>",
"sequencer": {
"authority": "sequencer",
"asOf": "2023-11-07T05:31:56Z",
"accountVersion": "<string>",
"cursor": "<string>"
},
"wallet": {
"authority": "wallet-svc+alephium-node",
"asOf": "2023-11-07T05:31:56Z"
},
"indexer": {
"authority": "main-rds-indexer-projection",
"asOf": "2023-11-07T05:31:56Z",
"consistency": "repeatable-read"
}
},
"collateral": {
"unit": "collateral_base_units",
"rawOnChainBalance": "<string>",
"spendable": "<string>",
"buyCollateralHolds": "<string>",
"matchedBuyObligations": "<string>",
"pendingJitDeposits": "<string>",
"pendingOutflows": "<string>",
"custodyOperationActive": true,
"tokenId": "<string>"
},
"positionReservations": {
"unit": "share_base_units",
"openSellHolds": "<string>",
"matchedSellObligations": "<string>"
},
"orders": {
"authority": "sequencer",
"items": [
{
"orderId": "<string>",
"marketId": "<string>",
"priceTick": 500,
"quantityBaseUnits": "<string>",
"openQuantityBaseUnits": "<string>",
"matchedPendingQuantityBaseUnits": "<string>",
"settledQuantityBaseUnits": "<string>",
"cancelledQuantityBaseUnits": "<string>",
"unwoundQuantityBaseUnits": "<string>",
"clientOrderId": "<string>",
"acceptedSequence": "<string>",
"acceptedAtMs": "<string>",
"expiryMs": "<string>",
"attribution": {
"version": "<string>",
"builderCode": "<string>"
}
}
],
"truncated": true,
"nextCursor": "<string>",
"continuation": "/v1/users/{address}/orders?status=all"
},
"holds": {
"authority": "sequencer",
"items": [
{
"holdId": "<string>",
"orderId": "<string>",
"source": "<string>",
"amountBaseUnits": "<string>",
"matchId": "<string>",
"allocatedSequence": "<string>"
}
],
"truncated": true,
"nextHoldId": "<string>"
},
"pendingSettlements": {
"authority": "sequencer",
"items": [
{
"matchId": "<string>",
"orderId": "<string>",
"marketId": "<string>",
"fillQuantityBaseUnits": "<string>",
"state": "<string>",
"batchJobId": "<string>",
"batchState": "<string>",
"transactionId": "<string>",
"blockHash": "<string>",
"confirmationDepth": "<string>",
"attribution": {
"version": "<string>",
"builderCode": "<string>"
}
}
],
"truncated": true,
"nextMatchId": "<string>"
},
"deadManSwitch": {
"generation": "<string>",
"stateVersion": "<string>",
"timeoutMs": 43202500,
"armedAt": "2023-11-07T05:31:56Z",
"lastHeartbeatAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"triggeredAt": "2023-11-07T05:31:56Z",
"source": {
"epoch": "<string>",
"sequence": "<string>",
"hash": "<string>"
}
},
"positions": {
"authority": "indexer-derived",
"unit": "collateral_display_and_share_display",
"items": [
{
"id": 123,
"marketId": 123,
"marketAddress": "<string>",
"shares": "<string>",
"averageCostProbability": "<string>",
"currentProbability": "<string>",
"priceObservedAtMs": "<string>",
"potentialPayoutCollateral": "<string>",
"lockedCollateral": "<string>",
"lockedShares": "<string>",
"unrealizedPnlCollateral": "<string>",
"settled": true,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"truncated": true,
"continuation": "/v1/users/{address}/positions"
},
"pnl": {
"authority": "indexer-derived",
"unit": "collateral_display",
"realizedWon": "<string>",
"realizedLost": "<string>",
"realizedNet": "<string>",
"unrealizedEstimate": "<string>",
"methodology": "open shares multiplied by latest retained price minus average cost; null-priced positions excluded"
},
"claimsAndEarnings": {
"payoutQueue": [
{
"amountBaseUnits": "<string>",
"count": 4503599627370495
}
],
"claimableWinningsBaseUnits": "<string>",
"pendingClaimsBaseUnits": "<string>",
"confirmedClaimsBaseUnits": "<string>",
"creatorEarningsBaseUnits": "<string>",
"referralEarningsBaseUnits": "<string>",
"makerRewardsCollateral": "<string>",
"makerRewardsState": [
{
"status": "<string>",
"amountCollateral": "<string>",
"count": 4503599627370495
}
]
},
"funding": {
"authority": "wallet-svc",
"pendingDepositsBaseUnits": "<string>",
"pendingOutflowsBaseUnits": "<string>",
"recent": [
{
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositBaseUnits": "<string>",
"attoAlphOutflow": "<string>",
"tokenOutflows": {},
"transactionId": "<string>",
"intentHash": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"history": {
"limit": 50,
"hasMore": true,
"nextCursor": "<string>",
"continuation": "/v1/funding/operations"
},
"historyStatus": "available"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Read a coherent private instant-trading account snapshot.
Composes sequencer-authoritative orders/holds/settlements, wallet+node-authoritative balances, and an indexer repeatable-read projection. The path wallet must match the authenticated session; a developer key never substitutes for user authority and additionally needs account:read when present.
A valid request URL is required to generate request examples{
"account": "<string>",
"snapshot": {
"generatedAt": "2023-11-07T05:31:56Z",
"streamCursor": "<string>",
"sequencer": {
"authority": "sequencer",
"asOf": "2023-11-07T05:31:56Z",
"accountVersion": "<string>",
"cursor": "<string>"
},
"wallet": {
"authority": "wallet-svc+alephium-node",
"asOf": "2023-11-07T05:31:56Z"
},
"indexer": {
"authority": "main-rds-indexer-projection",
"asOf": "2023-11-07T05:31:56Z",
"consistency": "repeatable-read"
}
},
"collateral": {
"unit": "collateral_base_units",
"rawOnChainBalance": "<string>",
"spendable": "<string>",
"buyCollateralHolds": "<string>",
"matchedBuyObligations": "<string>",
"pendingJitDeposits": "<string>",
"pendingOutflows": "<string>",
"custodyOperationActive": true,
"tokenId": "<string>"
},
"positionReservations": {
"unit": "share_base_units",
"openSellHolds": "<string>",
"matchedSellObligations": "<string>"
},
"orders": {
"authority": "sequencer",
"items": [
{
"orderId": "<string>",
"marketId": "<string>",
"priceTick": 500,
"quantityBaseUnits": "<string>",
"openQuantityBaseUnits": "<string>",
"matchedPendingQuantityBaseUnits": "<string>",
"settledQuantityBaseUnits": "<string>",
"cancelledQuantityBaseUnits": "<string>",
"unwoundQuantityBaseUnits": "<string>",
"clientOrderId": "<string>",
"acceptedSequence": "<string>",
"acceptedAtMs": "<string>",
"expiryMs": "<string>",
"attribution": {
"version": "<string>",
"builderCode": "<string>"
}
}
],
"truncated": true,
"nextCursor": "<string>",
"continuation": "/v1/users/{address}/orders?status=all"
},
"holds": {
"authority": "sequencer",
"items": [
{
"holdId": "<string>",
"orderId": "<string>",
"source": "<string>",
"amountBaseUnits": "<string>",
"matchId": "<string>",
"allocatedSequence": "<string>"
}
],
"truncated": true,
"nextHoldId": "<string>"
},
"pendingSettlements": {
"authority": "sequencer",
"items": [
{
"matchId": "<string>",
"orderId": "<string>",
"marketId": "<string>",
"fillQuantityBaseUnits": "<string>",
"state": "<string>",
"batchJobId": "<string>",
"batchState": "<string>",
"transactionId": "<string>",
"blockHash": "<string>",
"confirmationDepth": "<string>",
"attribution": {
"version": "<string>",
"builderCode": "<string>"
}
}
],
"truncated": true,
"nextMatchId": "<string>"
},
"deadManSwitch": {
"generation": "<string>",
"stateVersion": "<string>",
"timeoutMs": 43202500,
"armedAt": "2023-11-07T05:31:56Z",
"lastHeartbeatAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"triggeredAt": "2023-11-07T05:31:56Z",
"source": {
"epoch": "<string>",
"sequence": "<string>",
"hash": "<string>"
}
},
"positions": {
"authority": "indexer-derived",
"unit": "collateral_display_and_share_display",
"items": [
{
"id": 123,
"marketId": 123,
"marketAddress": "<string>",
"shares": "<string>",
"averageCostProbability": "<string>",
"currentProbability": "<string>",
"priceObservedAtMs": "<string>",
"potentialPayoutCollateral": "<string>",
"lockedCollateral": "<string>",
"lockedShares": "<string>",
"unrealizedPnlCollateral": "<string>",
"settled": true,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"truncated": true,
"continuation": "/v1/users/{address}/positions"
},
"pnl": {
"authority": "indexer-derived",
"unit": "collateral_display",
"realizedWon": "<string>",
"realizedLost": "<string>",
"realizedNet": "<string>",
"unrealizedEstimate": "<string>",
"methodology": "open shares multiplied by latest retained price minus average cost; null-priced positions excluded"
},
"claimsAndEarnings": {
"payoutQueue": [
{
"amountBaseUnits": "<string>",
"count": 4503599627370495
}
],
"claimableWinningsBaseUnits": "<string>",
"pendingClaimsBaseUnits": "<string>",
"confirmedClaimsBaseUnits": "<string>",
"creatorEarningsBaseUnits": "<string>",
"referralEarningsBaseUnits": "<string>",
"makerRewardsCollateral": "<string>",
"makerRewardsState": [
{
"status": "<string>",
"amountCollateral": "<string>",
"count": 4503599627370495
}
]
},
"funding": {
"authority": "wallet-svc",
"pendingDepositsBaseUnits": "<string>",
"pendingOutflowsBaseUnits": "<string>",
"recent": [
{
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositBaseUnits": "<string>",
"attoAlphOutflow": "<string>",
"tokenOutflows": {},
"transactionId": "<string>",
"intentHash": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"history": {
"limit": 50,
"hasMore": true,
"nextCursor": "<string>",
"continuation": "/v1/funding/operations"
},
"historyStatus": "available"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Authorizations
HttpOnly session cookie set by POST /v1/auth/session. Mutating requests must also send the CSRF token (returned by that call) in the x-csrf-token header.
Path Parameters
Alephium address (base58, optional :N group suffix).
30 - 80^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$Response
Default Response
Alephium address (base58, optional :N group suffix).
30 - 80^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes

