List Portfolio Products

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java
.NET
Go
Python
CLI
TS/JS

ProductsService productsService = PrimeServiceFactory.createProductsService(client);

ListPortfolioProductsRequest request = new ListPortfolioProductsRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .build();

ListPortfolioProductsResponse response = productsService.listPortfolioProducts(request);

For more information, please visit the Prime Java SDK.

Path Parameters

portfolio_id

string

required

The portfolio ID

Query Parameters

cursor

string

Cursor used for pagination (last consumed record)

limit

integer<int32>

Number of items to retrieve

sort_direction

enum<string>

default:DESC

Sorting order

Available options:

DESC,

ASC

Response

200 - application/json

A successful response.

products

object[]

Show child attributes

string

The product ID, written as BASE-QUOTE

Example:

"BTC-USD"

base_increment

string

The smallest permitted unit of denomination for the base asset (varies by product)

Example:

"1"

quote_increment

string

The smallest permitted unit of denomination for the quote asset (varies by product)

Example:

"1"

base_min_size

string

The minimum size (in base asset units) for which an order can be placed

Example:

"100"

quote_min_size

string

The minimum size (in quote asset units) for which an order can be placed

Example:

"100"

base_max_size

string

The maximum size (in base asset units) for which an order can be placed

Example:

"1000"

quote_max_size

string

The maximum size (in quote asset units) for which an order can be placed

Example:

"1000"

permissions

enum<string>[]

Permissions given to the user for a product

Available options:

PRODUCT_PERMISSION_READ,

PRODUCT_PERMISSION_TRADE,

PRODUCT_PERMISSION_LENDING

Example:

"PRODUCT_PERMISSION_READ"

price_increment

string

The smallest permitted price increment for the product

Example:

"0.01"

rfq_product_details

object

Show child attributes

rfq_product_details.tradable

boolean

Whether the product is tradable via RFQ

rfq_product_details.min_notional_size

string

Deprecated: Value will be an empty string

rfq_product_details.max_notional_size

string

Deprecated: Value will be an empty string

rfq_product_details.min_base_size

string

Minimum base size for RFQ

rfq_product_details.max_base_size

string

Maximum base size for RFQ

rfq_product_details.min_quote_size

string

Minimum quote size for RFQ

rfq_product_details.max_quote_size

string

Maximum quote size for RFQ

pagination

object

Show child attributes

pagination.next_cursor

string

required

Cursor to navigate to next page

pagination.sort_direction

enum<string>

default:DESC

required

Available options:

DESC,

ASC

pagination.has_next

boolean

required

A boolean value indicating whether there are more items to paginate through

REST API

FIX API

Websocket Feed

Path Parameters

Query Parameters

Response