Ctrl+K

Get balances for a credential

get/venue-adapter-service/api/vas/v1/credential/{credentialExternalId}/balances

Returns balances for the specified credential external ID.

Path Parameters

  • credentialExternalIdstringRequired
    CMS credential external ID to fetch balances for
    Min length: >= 1 characters

200 Response

balances array[object] required
credentialExternalId string required
Min length: >= 1 characters
genericAsset string
Min length: >= 1 characters
venueAsset string required
Min length: >= 1 characters
total string required
Min length: >= 1 characters
available string required
Min length: >= 1 characters
locked string required
Min length: >= 1 characters
timestamp string <date-time>required
accountSubTypeOne ofrequired
Narrow keyof codec for the committed normalized constants. Use where a value MUST be one of the committed names (e.g. venue config's `normalized` field, where the venue mapping author commits to a known constant).
Allowed values: SPOT CROSS_MARGIN ISOLATED_MARGIN PERP_FUTURES DELIVERY_FUTURES OPTIONS FUNDING EARN UNIFIED

400 Response

errorName string required
error string required

404 Response

errorName string required
error string required

500 Response

errorName string required
error string required