Skip to content

Commit 28d9ccf

Browse files
authored
Iterator note (#159)
1 parent f5d9974 commit 28d9ccf

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/source/Getting-Started.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,12 @@ For paginated endpoints call :code:`list_*` and use the provided iterator:
4040
trades.append(t)
4141
print(trades)
4242
43-
For endpoints that have a set of parameters you can use the provided enums:
43+
.. note::
44+
The number of network requests made by the iterator depends on the value of the parameter :code:`limit`.
45+
:code:`limit` specifies how many results should be returned per network request.
46+
You can see each network request by passing :code:`verbose = True` to the client.
47+
48+
For endpoints that have a set of parameters you can use the provided :doc:`enums </Enums>`.
4449

4550
.. code-block:: python
4651

0 commit comments

Comments
 (0)