Skip to content

Commit f5fe6d0

Browse files
committed
Add documentation for Account PNL snapshot request
1 parent 953b1ab commit f5fe6d0

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ Features
3333
realtime_data
3434
orders
3535
historical_data
36+
pnl

docs/pnl.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
list_account_summary
2+
3+
PNL API
4+
=========
5+
6+
Account PNL snapshot
7+
--------------------
8+
9+
Use `list_account_summary()` to retrieve the PNL snapshot of an account.
10+
11+
.. code-block:: python
12+
13+
accounts = await client.list_account_summary(account_id="1234")
14+
15+
The result is a list which contains a single object. See the `account_pnl_position_update.proto <https://github.com/rundef/async_rithmic/blob/main/async_rithmic/protocol_buffers/source/account_pnl_position_update.proto>`_ definition for field details.

0 commit comments

Comments
 (0)