Transaction

Transaction record for a closed deal.

  • closedUtc
    Type: stringFormat: date-time
    required

    When the deal closed (ISO 8601 UTC).

  • type
    Type: string
    required

    Transaction type: "sell" (future: "buy").

  • buyer
    Type: object · TransactionParty nullable

    Buyer details (populated for sell transactions).

    • name
      Type: null | string

      Party name (if disclosed).

    • prospectId
      Type: null | string

      ID of the prospect associated with this party (if applicable).

    • type
      Type: null | string

      Party type: "internal" (platform user), "external" (outside party), or "unknown".

  • price
    Type: object · PriceRange nullable

    Transaction price.

    • currency
      Type: string
      min length:  
      3
      max length:  
      3
      required

      ISO 4217 currency code (e.g., "EUR", "SEK", "USD").

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum price. Multiply by scale factor to get actual amount. Example: max=200 with scale="millions" = 200 million.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum price. Multiply by scale factor to get actual amount. Example: min=100 with scale="millions" = 100 million.

    • scale
      Type: string

      Scale factor for the values: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.

  • seller
    Type: object · TransactionParty nullable

    Seller details (populated for buy transactions).

    • name
      Type: null | string

      Party name (if disclosed).

    • prospectId
      Type: null | string

      ID of the prospect associated with this party (if applicable).

    • type
      Type: null | string

      Party type: "internal" (platform user), "external" (outside party), or "unknown".

  • yield
    Type: object · PercentRange nullable

    Yield at transaction.

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Maximum percentage (e.g., 8.0 = 8%).

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

      Minimum percentage (e.g., 5.0 = 5%).

Propstreet API Documentation