Skip to main content
POST
/
v1beta1
/
get_account_balance
Get Account Balance
curl --request POST \
  --url https://traderapi.us-east-1.privatelink.preprod.polymarketexchange.com/api/v1beta1/get_account_balance \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "<string>",
  "name": "<string>"
}
'
{
  "balance": "100000.00",
  "capital_requirement": "25000.00",
  "excess_capital": "80500.00",
  "buying_power": "72000.00",
  "margin_requirement": "5500.00",
  "open_orders": "8500.00",
  "unsettled_funds": "2000.00",
  "total_security_notional_value": "15000.00",
  "total_security_available_value": "13500.00",
  "securities": {
    "USD": {
      "balance": "15000.00",
      "market_value": "1.00",
      "notional_value": "15000.00",
      "haircut": "1000",
      "available_value": "13500.00"
    }
  }
}

Body

application/json

Request to get the balance of the given account in the given currency.

​
currency
string

ISO currency code of the fiat currency for which to get the balance (ie: "USD") (required).

​
name
string

Fully qualified resource name of the account to get the balance for (ie: "firms/[firmid]/accounts/[accountid]") (required).

Response

A successful response.

​
alternate_capital_requirement
string

The fixed amount of capital requirement in the alternate capital requirement currency.

​
alternate_capital_requirement_currency
string

If exists, the alternate currency used for capital requirement.

​
balance
string

Fixed point decimal fiat currency balance, not including any security values.

​
buying_power
string

Amount of unencumbered capital available for trading, factoring in all security valuations as well as any open orders.

​
capital_requirement
string

Required amount of fiat currency balance that must be held in an account and cannot be used for trading.

​
excess_capital
string

Amount of excess capital in the balance beyond the requirement, factoring in all security valuations.

​
margin_requirement
string

Aggregate margin requirement for each Event Instrument.

​
open_orders
string

Aggregate total notional value of open orders.

​
securities
object

Map of securities mapped by ID to their detailed valuation with respect to the market price and adjustments applied.

​
total_security_available_value
string

Aggregate available collateral value of all securities.

​
total_security_notional_value
string

Aggregate notional value of all securities.

​
unsettled_funds
string

Aggregate total notional value of unsettled funds not yet available to trade.