Skip to main content

PURCHASE POWER​

This API returns the total purchasing power available to the user for trading activities.

Purchasing power represents the effective amount available for placing orders based on the user's available funds, margins, and configured limits.

🔍 Query Parameters​

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 Header Parameters​

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Purchase power fetched successfully"
datastringTotal purchasing power available to the user"125000.50"