Cash Balances
Download SpecAll cash balance related paths
Retrieve an account group's cash balance
Retrieve an account group's cash balance
Authentication
oauth-client-credentials
Required Scopes:
positions:read
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
account_group_id
string
uuid
required
Account group unique identifier.
currency
string
ISO4217
required
Three-letter ISO 4217 alphabetical currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
balance
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
locked_for_trading
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
pending_settlement
string
^[0-9]{0,63}(\.[0-9]{1,27})?$
required
available_for_withdrawal
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
available_for_trading
string
^-?[0-9]{0,63}(\.[0-9]{1,27})?$
required
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
type
string
required
URL to a document describing the error condition.
status
int
required
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
Response Examples
{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "80",
"available_for_withdrawal": "80",
"balance": "100.25",
"currency": "EUR",
"locked_for_trading": "10",
"pending_settlement": "10"
}
{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "0",
"available_for_withdrawal": "0",
"balance": "1000",
"currency": "EUR",
"locked_for_trading": "1000",
"pending_settlement": "0"
}
{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "0",
"available_for_withdrawal": "0",
"balance": "0",
"currency": "EUR",
"locked_for_trading": "0",
"pending_settlement": "0"
}
{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "828.75",
"available_for_withdrawal": "0",
"balance": "828.75",
"currency": "EUR",
"locked_for_trading": "0",
"pending_settlement": "828.75"
}
{
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "0",
"available_for_withdrawal": "200",
"balance": "200",
"currency": "EUR",
"locked_for_trading": "0",
"pending_settlement": "0"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Responses
Request Examples
{
"created_at": "2021-07-21T14:11:00.00Z",
"id": "8c049f77-dc72-489d-8f5f-3871db782252",
"object": {
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "0",
"available_for_withdrawal": "0",
"balance": "0",
"currency": "EUR",
"locked_for_trading": "0",
"pending_settlement": "0"
},
"type": "CASH_BALANCE.UPDATED",
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}
{
"created_at": "2021-07-22T14:12:00.00Z",
"id": "a59c81ee-7770-4f6b-9ebe-8c268b78beb4",
"object": {
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "0",
"available_for_withdrawal": "0",
"balance": "200",
"currency": "EUR",
"locked_for_trading": "0",
"pending_settlement": "0"
},
"type": "CASH_BALANCE.UPDATED",
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}
{
"created_at": "2021-07-21T14:10:00.00Z",
"id": "8962b496-8d42-4560-bfab-10490dd1a724",
"object": {
"account_group_id": "d0fc0305-97b7-4e3b-bddf-66d3c434898c",
"available_for_trading": "80",
"available_for_withdrawal": "80",
"balance": "100.25",
"currency": "EUR",
"locked_for_trading": "10",
"pending_settlement": "10"
},
"type": "CASH_BALANCE.UPDATED",
"webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}
Was this page helpful?