OAuth2 Authentication

Access Tokenpost

Reference API

Entities
- List entitiesget
- Get entityget
Accounts
- List accountsget
- Get accountget
Instruments
- Get instrumentget

Execution API

Orders
Trades
- Get tradeget
- List tradesget
Positions
- Get positionget
- List positionsget
WebSockets
- Activity Channel

Lending API

Locates
Rates
- List easy borrowsget
Inventories
- Get inventoryget

Risk & Margin API

PNL
Margin
- Get Reg-T marginget
- Get portfolio marginget
Margin Simulations
- Create Reg-T simulationpost
- Get Reg-T simulationget

Custodial API

Performance
- List PNL Sumsget
Holdings
- List holdingsget

OAuth2 Authentication

Access Tokenpost

Reference API

Entities
- List entitiesget
- Get entityget
Accounts
- List accountsget
- Get accountget
Instruments
- Get instrumentget

Execution API

Orders
Trades
- Get tradeget
- List tradesget
Positions
- Get positionget
- List positionsget
WebSockets
- Activity Channel

Lending API

Locates
Rates
- List easy borrowsget
Inventories
- Get inventoryget

Risk & Margin API

PNL
Margin
- Get Reg-T marginget
- Get portfolio marginget
Margin Simulations
- Create Reg-T simulationpost
- Get Reg-T simulationget

Custodial API

Performance
- List PNL Sumsget
Holdings
- List holdingsget

List account PNL details

get https://api.clearstreet.io/studio/v2/accounts/{account_id}/pnl-details

List PNL details for a given account.

Path Params

account_id

string

required

length between 1 and 256

The account ID or account number to list PNL details for.

Responses

Response body

object

data

array of objects

required

data*

object

timestamp

int64

required

1710613560668 to 2900000000000

Milliseconds since epoch.

entity_id

string

required

length between 1 and 256

Name of the legal entity.

account_id

string

required

length between 1 and 256

Account ID for the account.

account_number

string

required

length between 1 and 256

Account number for the account.

symbol

string

required

length between 1 and 32

symbol_description

string

required

Description of the symbol.

asset_class

string

required

The asset class of the symbol.

other currency equity option debt fund

day_pnl

double

required

Profit and loss from intraday trading activities.

unrealized_pnl

double

required

Profit and loss from market changes.

realized_pnl

double

required

Profit and loss realized from position closing trading activity.

total_pnl

double

required

realized_pnl + unrealized_pnl

overnight_pnl

double

required

Profit and loss from previous trading date.

total_fees

double

required

Total fees incurred from trading activities.

net_market_value

double

required

Market value net of long and short market values.

gross_market_value

double

required

Absolute market value of long and short market values.

sod_market_value

double

required

Market value of a given instrument a the start of a trading day.

quantity

string

required

length between 1 and 16

String representation of quantity.

sod_quantity

string

required

length between 1 and 16

Quantity of a given instrument at the start of a trading day.

bought_quantity

string

required

length between 1 and 16

Quantity of a given instrument bought.

sold_quantity

string

required

length between 1 and 16

Quantity of a given instrument sold.

buys

int32

required

Total buys of a given instrument.

sells

int32

required

Total sells of a given instrument.

price

double

required

Price used in this pnl calculation.

sod_price

double

required

Price at the start of a trading day.

underlier

string

required

length between 1 and 32

The underlying instrument.

Response body

object

type

uri

A URI reference that identifies the problem type.

title

string

A short, human-readable summary of the problem type.

status

number

100 to 599

The HTTP status code generated by the origin server for this occurrence of the problem.

detail

string

A human-readable explanation specific to this occurrence of the problem.

instance

uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Updated 12 months ago

Get account PNL summary

Margin

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.clearstreet.io/studio/v2/accounts/account_id/pnl-details \
3
     --header 'accept: application/json'

Choose an example:

application/json

Updated 12 months ago

Get account PNL summary

Margin

Did this page help you?

OAuth2 Authentication
Access Tokenpost

Reference API
Entities
Get entityget
List entitiesget
Accounts
Get accountget
List accountsget
Instruments
Get instrumentget

Execution API
Orders
Update orderpatch
Delete orderdelete
Get orderget
Delete all ordersdelete
List ordersget
Create orderpost
Create bulk orderspost
Trades
List tradesget
Get tradeget
Positions
List positionsget
Get positionget
WebSockets
Activity Channel

Lending API
Locates
Update locate orderpatch
Get locate orderget
List locate ordersget
Create locate orderpost
Rates
List easy borrowsget
Inventories
Get inventoryget

Risk & Margin API
PNL
List account PNL detailsget
Get account PNL summaryget
Get entity PNL summaryget
Margin
Get portfolio marginget
Get Reg-T marginget
Margin Simulations
Get Reg-T simulationget
Create Reg-T simulationpost

Custodial API
Performance
List PNL Sumsget
Holdings
List holdingsget

OAuth2 Authentication
Access Tokenpost

Reference API
Entities
Get entityget
List entitiesget
Accounts
Get accountget
List accountsget
Instruments
Get instrumentget

Execution API
Orders
Update orderpatch
Delete orderdelete
Get orderget
Delete all ordersdelete
List ordersget
Create orderpost
Create bulk orderspost
Trades
List tradesget
Get tradeget
Positions
List positionsget
Get positionget
WebSockets
Activity Channel

Lending API
Locates
Update locate orderpatch
Get locate orderget
List locate ordersget
Create locate orderpost
Rates
List easy borrowsget
Inventories
Get inventoryget

Risk & Margin API
PNL
List account PNL detailsget
Get account PNL summaryget
Get entity PNL summaryget
Margin
Get portfolio marginget
Get Reg-T marginget
Margin Simulations
Get Reg-T simulationget
Create Reg-T simulationpost

Custodial API
Performance
List PNL Sumsget
Holdings
List holdingsget

200Account PNL details

defaultError response