Documentation Clarification for List Orders

Share Feedback
1

The documentation for List Orders does not state how to pass/encode the order_status query parameter. When you fill in “OPEN”, and “CANCELLED” in the documenatation form, it produces the Python example (and similar URLs for Node, etc) conn.request("GET", "/api/v3/brokerage/orders/historical/batch?order_status=CANCELLED,OPEN&end_date=d, payload, headers)", but when attempting the same in an actual query, I receive the failure message: {"error":"unknown","error_details":"CANCELLED,OPEN is not a valid retail_brokerage_api.OrderExecutionStatus","message":"CANCELLED,OPEN is not a valid retail_brokerage_api.OrderExecutionStatus"}.

Generally speaking, the docs need information on how to pass multiple arguments for the same parameter, since order_status=CANCELLED works for me, as does using “OPEN”, but the two comma-separated as shown in the example does not work. That said, the error message is great and informative!

Thanks!

2

In addition to this, the example JSON for this endpoint is incorrect. It shows a singular response, like the below:

{
  "orders": {
        "order_id": "0000-000000-000000",
        "product_id": "BTC-USD",
        ...
    }
}

when it should show a list of such responses, which is what the endpoint actually returns, like the below:

{
    "orders": [
        {
            "order_id": "0000-000000-000000",
            "product_id": "BTC-USD",
            ...,
        },
        ...
    ]
}