Skip to content

Commit a9055b9

Browse files
drew887drew887
authored
Adds a 'side' param to Rest::list_orders (#610)
* Adds a 'side' param to Rest::list_orders * Update README as well
1 parent d512c40 commit a9055b9

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

‎README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -338,22 +338,22 @@ You can access the following information through this object.
338338

339339
#### API REST Methods
340340

341-
| Rest Method | End Point | Result |
342-
| -------------------------------- | -------------------| ------------------------------------------------------------------ |
343-
| get_account() | `GET /account` and | `Account` entity.|
344-
| get_order_by_client_order_id(client_order_id) | `GET /orders` with client_order_id | `Order` entity.|
345-
| list_orders(status=None, limit=None, after=None, until=None, direction=None, nested=None) | `GET /orders` | list of `Order` entities. `after` and `until` need to be string format, which you can obtain by `pd.Timestamp().isoformat()` |
346-
| submit_order(symbol, qty=None, side="buy", type="market", time_in_force="day", limit_price=None, stop_price=None, client_order_id=None, order_class=None, take_profit=None, stop_loss=None, trail_price=None, trail_percent=None, notional=None)| `POST /orders` | `Order` entity. |
347-
| get_order(order_id) | `GET /orders/{order_id}` | `Order` entity.|
348-
| cancel_order(order_id) | `DELETE /orders/{order_id}` | |
349-
| cancel_all_orders() | `DELETE /orders`| |
350-
| list_positions() | `GET /positions` | list of `Position` entities|
351-
| get_position(symbol) | `GET /positions/{symbol}` | `Position` entity.|
352-
| list_assets(status=None, asset_class=None) | `GET /assets` | list of `Asset` entities|
353-
| get_asset(symbol) | `GET /assets/{symbol}` | `Asset` entity|
354-
| get_clock() | `GET /clock` | `Clock` entity|
355-
| get_calendar(start=None, end=None) | `GET /calendar` | `Calendar` entity|
356-
| get_portfolio_history(date_start=None, date_end=None, period=None, timeframe=None, extended_hours=None) | `GET /account/portfolio/history` | PortfolioHistory entity. PortfolioHistory.df can be used to get the results as a dataframe|
341+
| Rest Method | End Point | Result |
342+
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
343+
| get_account() | `GET /account` and | `Account` entity. |
344+
| get_order_by_client_order_id(client_order_id) | `GET /orders` with client_order_id | `Order` entity. |
345+
| list_orders(status=None, limit=None, after=None, until=None, direction=None, params=None,nested=None, symbols=None, side=None) | `GET /orders` | list of `Order` entities. `after` and `until` need to be string format, which you can obtain by `pd.Timestamp().isoformat()` |
346+
| submit_order(symbol, qty=None, side="buy", type="market", time_in_force="day", limit_price=None, stop_price=None, client_order_id=None, order_class=None, take_profit=None, stop_loss=None, trail_price=None, trail_percent=None, notional=None) | `POST /orders` | `Order` entity. |
347+
| get_order(order_id) | `GET /orders/{order_id}` | `Order` entity. |
348+
| cancel_order(order_id) | `DELETE /orders/{order_id}` | |
349+
| cancel_all_orders() | `DELETE /orders` | |
350+
| list_positions() | `GET /positions` | list of `Position` entities |
351+
| get_position(symbol) | `GET /positions/{symbol}` | `Position` entity. |
352+
| list_assets(status=None, asset_class=None) | `GET /assets` | list of `Asset` entities |
353+
| get_asset(symbol) | `GET /assets/{symbol}` | `Asset` entity |
354+
| get_clock() | `GET /clock` | `Clock` entity |
355+
| get_calendar(start=None, end=None) | `GET /calendar` | `Calendar` entity |
356+
| get_portfolio_history(date_start=None, date_end=None, period=None, timeframe=None, extended_hours=None) | `GET /account/portfolio/history` | PortfolioHistory entity. PortfolioHistory.df can be used to get the results as a dataframe |
357357

358358
#### Rest Examples
359359

‎alpaca_trade_api/rest.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,8 @@ def list_orders(self,
309309
direction: str = None,
310310
params=None,
311311
nested: bool = None,
312-
symbols: List[str] = None
312+
symbols: List[str] = None,
313+
side: str = None
313314
) -> Orders:
314315
"""
315316
Get a list of orders
@@ -323,6 +324,7 @@ def list_orders(self,
323324
:param params: refer to documentation
324325
:param nested: should the data be nested like json
325326
:param symbols: list of str (symbols)
327+
:param side: Lets you filter to only 'buy' or 'sell' orders
326328
"""
327329
if params is None:
328330
params = dict()
@@ -338,6 +340,8 @@ def list_orders(self,
338340
params['status'] = status
339341
if nested is not None:
340342
params['nested'] = nested
343+
if side is not None:
344+
params['side'] = side
341345
if symbols is not None:
342346
params['symbols'] = ",".join(symbols)
343347
url = '/orders'

0 commit comments

Comments
 (0)