CapitalFlow icon

CapitalFlow

Interact with the CapitalFlow API

Actions38

Contract → Get

AI-generated

Summary

Retrieve detailed information about a specific contract by its unique Contract ID, specifying whether it is an asset or hedge category and selecting the appropriate contract type.

Inputs

  • Category (required) — Selects the contract category to disambiguate overlapping contract names between asset and hedge types (options: 'asset' or 'hedge').
  • Contract Type (required) — Specifies the specific contract type within the chosen category to determine the request schema. For 'asset' category, options include types like 'Checking Account', 'Property', 'Private Pension', etc. For 'hedge' category, options include types like 'Liability Insurance', 'Car Insurance', 'Term Life Insurance', etc.
  • Contract ID (required) — The unique identifier of the contract to retrieve.

Output shape

a single JSON object representing the contract details

The output contains all details of the requested contract according to its category and type. The operation returns a single contract record matching the provided Contract ID. Errors or missing data will be surfaced if the contract cannot be found or accessed.

Links

Discussion