Get portfolio details

get https://api.bsx.exchange/portfolio/detail

Get your portfolio details including balances, total PnL, etc.

Requires authentication.

Responses

Response body

object

account

string

summary

object

collateral_mode

string

Defaults to MULTI_COLLATERAL

MULTI_COLLATERAL USDC_COLLATERAL

collateral_margin_balance

string

Collateral value utilized as margin. This represents the total collateral value when the portfolio is in MULTI_COLLATERAL. If the portfolio is in USDC_COLLATERAL, it includes only the USDC amount.

cross_margin_balance

string

Cross margin balance.

margin_usage

string

Cross margin usage.

account_leverage

string

Cross account leverage.

in_liquidation

boolean

Cross in liquidation.

free_collateral

string

Free cross margin balance.

total_account_value

string

Total account value.

total_notional

string

Total cross notional.

usdc_balance

string

USDC balance.

unsettled_usdc

string

Total cross and isolated unsettled USDC.

realized_pnl

string

Realized PnL.

total_initial_margin

string

Total cross initial margin.

total_maintenance_margin

string

Total cross maintenance margin.

token_balances

array of objects

Token balances.

token_balances

object

address

string

Token address.

balance

string

Available balance of the given tokens.

has_pending_withdrawal

boolean

Has pending withdrawal.

total_unrealized_pnl

string

Total cross and isolated unrealized PnL.

total_collateral_value

string

Total collateral value.

margin_health

string

Cross initial margin health.

has_pending_swap

boolean

Has pending swap.

total_isolated_order_reserve

string

Total isolated order reserve.

has_pending_transfer_perp_to_degen

boolean

Has pending transfer perp to degen.

has_pending_stake_vault

boolean

Has pending stake vault.

has_pending_unstake_vault

boolean

Has pending unstake vault.

has_pending_transfer_perp

boolean

Has pending transfer perp.

pay_fees_in_bsx_enabled

boolean

Pay fees in BSX enabled.

positions

array of objects

positions

object

product_index

int64

Product index.

product_id

string

Product id.

margin_mode

string

Defaults to CROSS

CROSS ISOLATED

margin_balance

string

Margin balance.

net_size

string

Position net size.

avg_entry_price

string

Average entry price.

initial_margin_requirement

string

Position initial margin.

maintenance_margin_requirement

string

Position maintenance margin.

liquidation_price

string

Liquidation price.

unrealized_pnl

string

Unrealized PnL.

mark_price

string

Mark price.

leverage

string

Leverage.

unsettled_funding

string

Unsettled funding.

funding_index

string

Funding index.

quote_balance

string

Quote balance.

stop_position

object

index_price

string

Index price.

isolated_usdc_balance

string

Isolated USDC balance.

in_isolated_liquidation

boolean

In isolated liquidation.

free_isolated_usdc_balance

string

Free isolated USDC balance.

maker_fee

float

Maker fee rate.

taker_fee

float

Taker fee rate.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.bsx.exchange/portfolio/detail \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.