Accounts
accounts
Methods
List all available accounts.
Get an account by its ID or number.
Domain types
Bulk Orders
accounts.bulk_orders
Methods
Creates multiple orders in a single request, up to 1000. Note that a successful call to this endpoint does not necessarily mean your orders have been accepted, e.g. a downstream venue might reject your order. You should therefore utilize our WebSocket APIs to listen for changes in order lifecycle events.
The response will contain an array of objects, indicating whether your order was submitted. If the order was submitted, the order_id field will be populated with the order ID assigned to this order. If the order was rejected, the reason field will be populated with the reason for rejection. The data array returned in the response object is guaranteed to be ordered in the same order as the orders you provided in the request. Again, note that even if your order was submitted, that doesn't mean it was accepted, and may still be rejected by downstream venues.
Easy Borrows
accounts.easy_borrows
Methods
List all current easy-to-borrow stock symbols. This list changes dynamically daily.
Holdings
accounts.holdings
Methods
List holdings for a given account, filtered on the given query parameters. This endpoint will return either historical or real-time holdings directly from our custodial systems. Positions returned here are can be different than positions returned from the Execution API. While the Execution API returns positions based on trading activity within Studio, our custodial system returns all positions regardless of where trades occur.
Inventories
accounts.inventories
Methods
Get located inventory for a symbol.
Locate Orders
accounts.locate_orders
Methods
Create locate order to borrow inventory for short-selling.
List all locate orders
Get locate order by its unique locate order ID.
Accept or decline locate order that has been offered.
Orders
accounts.orders
Methods
Attempts to cancel an existing order. Cancelling an order cannot be guaranteed as there might be in-flight executions.
Creates a new order and sends to our internal systems for execution. Note that a successful call to this endpoint does not necessarily mean your order has been accepted, e.g. a downstream venue might reject your order. You should therefore utilize our WebSocket APIs to listen for changes in order lifecycle events.
Attempts to cancel all open orders for a given account. Cancelling an order cannot be guaranteed as there might be in-flight executions.
List orders for a given account for the current trading day, filtered on the given query parameters.
Attempts to update an existing order. This can be used to update a subset of an order's attributes, for example price and quantity.
Get an order that was previously created.
Pnl Details
accounts.pnl_details
Methods
List PNL details for a given account.
Pnl Summary
accounts.pnl_summary
Methods
Get PNL summary for a given account.
Pnl Sums
accounts.pnl_sums
Methods
List historical PNL summations for a given account over a given date range, filtered on the given query parameters.