Skip to main content
GET
List Portfolio Allocations

Path Parameters

portfolio_id
string
required

Portfolio to retrieve allocations for.

Query Parameters

product_ids
string[]

List of products by which to filter the response.

order_side
enum<string>

An order side to filter allocations on.

  • UNKNOWN_ORDER_SIDE: nil value
  • BUY: Buy order
  • SELL: Sell order
Available options:
BUY,
SELL
start_date
string<date-time>
required

A start date for the allocations to be queried from.

end_date
string<date-time>

An end date for the orders to be queried from.

cursor
string

Id to retrieve additional results strictly after

limit
integer<int32>

Number of items to retrieve

sort_direction
enum<string>
default:DESC

Sorting order: DESC or ASC

Available options:
DESC,
ASC

Response

200 - application/json

A successful response.

allocations
object[]

List of allocations.

pagination
object