CapitalFlow icon

CapitalFlow

Interact with the CapitalFlow API

Actions38

Contract → List

AI-generated

Summary

List contracts for a specified customer filtered by contract category (Asset or Hedge) and contract type, supporting pagination and result limit.

Inputs

  • contractCategory (required) — Selects contract category to disambiguate between asset and hedge contracts (e.g., 'asset' or 'hedge').
  • assetContractType (required) — Specifies the type of asset contract to list (shown only if 'Asset' category is selected).
  • hedgeContractType (required) — Specifies the type of hedge contract to list (shown only if 'Hedge' category is selected).
  • customerId (required) — Customer identifier or name to list contracts for; selectable from a dynamic list or via expression.
  • page — Page number for paginated results, minimum 1, defaults to 1.
  • limit — Maximum number of contract results to return, between 1 and 200, defaults to 50.

Output shape

a list of contract records matching the specified customer, category, type, and pagination parameters

Results are paginated and limited by the 'page' and 'limit' inputs; output shape corresponds to the API's contract listing response.

Links

Discussion