Changelog
Introduction

Sections

Theme switcher

Get Max Amount To Withdraw

This endpoint retrieves the maximum amount that the user is eligible to withdraw from their challenge. This takes into consideration factors such as account balance, initial balance, and profit split. This endpoint is essential to understand current withdrawal capacity.

Header Parameters

Authorizationstring

Path Parameters

accountIdstring

Response

200
Object
OK

Response Attributes

maxAmountnumber

The total profit made by the trader may be withdrawn. Does not include the profit split

profitSplitobject

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?