Skip to content

Commit 60342f4

Browse files
committed
docs:: describe raw_data argument to api objects.
1 parent 397fad9 commit 60342f4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,13 @@ The steps to execute this are:
345345
* execute your algorithm. it will connect to the servers through the proxy agent allowing you to execute multiple strategies
346346

347347

348+
## Raw Data vs Entity Data
349+
By default the data returned from the api or streamed via StreamConn is wrapped with an Entity object for ease of use.<br>
350+
Some users may prefer working with raw python objects (lists, dicts, ...). <br>You have 2 options to get the raw data:
351+
* Each Entity object as a `_raw` property that extract the raw data from the object.
352+
* If you only want to work with raw data, and avoid casting to Entity (which may take more time, casting back and forth) <br>you could pass `raw_data` argument
353+
to `Rest()` object or the `StreamConn()` object.
354+
348355
## Support and Contribution
349356

350357
For technical issues particular to this module, please report the

0 commit comments

Comments
 (0)