Preqin Investor Commitment (Add-on) API

openapi: 3.2.0
info:
  title: Operational API Documentation Investor Commitment (Add-on)…
  description: The Operational API is a RESTFul API that provides access to the industry's most comprehensive Private Capital and Hedge Fund data sets and tools. Alternative asset professionals rely on it to make data-driven decisions throughout the entire investment lifecycle.
  contact:
    name: Preqin
    email: apiqueries@preqin.com
  license:
    name: Privacy Policy
    url: https://www.preqin.com/item/privacy-policy/1592
  version: v1
servers:
- url: https://api.preqin.com
security:
- bearer: []
tags:
- name: Investor Commitment (Add-on)
  description: Retrieve investor commitment data, including commitment sizes and the funds and managers to which investors have committed.
paths:
  /api/investor/commitment/pe/{investorId}:
    get:
      tags:
      - Investor Commitment (Add-on)
      description: PE Investor Commitment data
      operationId: InvestorCommitment_CommitmentPE
      parameters:
      - name: investorId
        in: path
        required: true
        description: Pass the Firm ID to be queried.
        schema:
          type: string
        x-position: 1
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Vintage
        in: query
        description: Pass the vintage year to be queried.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestorCommitmentPEResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No Results Found
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
      summary: Investor commitment commitment PE
      x-summary-source: derived
  /api/investor/commitment/pd/{investorId}:
    get:
      tags:
      - Investor Commitment (Add-on)
      description: PD Investor Commitment data
      operationId: InvestorCommitment_CommitmentPD
      parameters:
      - name: investorId
        in: path
        required: true
        description: Pass the Firm ID to be queried.
        schema:
          type: string
        x-position: 1
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Vintage
        in: query
        description: Pass the vintage year to be queried.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestorCommitmentPDResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No Results Found
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
      summary: Investor commitment commitment PD
      x-summary-source: derived
  /api/investor/commitment/re/{investorId}:
    get:
      tags:
      - Investor Commitment (Add-on)
      description: RE Investor Commitment data
      operationId: InvestorCommitment_CommitmentRE
      parameters:
      - name: investorId
        in: path
        required: true
        description: Pass the Firm ID to be queried.
        schema:
          type: string
        x-position: 1
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Vintage
        in: query
        description: Pass the vintage year to be queried.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestorCommitmentREResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No Results Found
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
      summary: Investor commitment commitment RE
      x-summary-source: derived
  /api/investor/commitment/inf/{investorId}:
    get:
      tags:
      - Investor Commitment (Add-on)
      description: INF Investor Commitment data
      operationId: InvestorCommitment_CommitmentINF
      parameters:
      - name: investorId
        in: path
        required: true
        description: Pass the Firm ID to be queried.
        schema:
          type: string
        x-position: 1
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Vintage
        in: query
        description: Pass the vintage year to be queried.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestorCommitmentINFResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No Results Found
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
      summary: Investor commitment commitment INF
      x-summary-source: derived
  /api/investor/commitment/nr/{investorId}:
    get:
      tags:
      - Investor Commitment (Add-on)
      description: NR Investor Commitment data
      operationId: InvestorCommitment_CommitmentNR
      parameters:
      - name: investorId
        in: path
        required: true
        description: Pass the Firm ID to be queried.
        schema:
          type: string
        x-position: 1
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Vintage
        in: query
        description: Pass the vintage year to be queried.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestorCommitmentNRResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No Results Found
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
      summary: Investor commitment commitment NR
      x-summary-source: derived
  /api/investor/commitment/hf/{investorId}:
    get:
      tags:
      - Investor Commitment (Add-on)
      description: HF Investor Commitment data
      operationId: InvestorCommitment_CommitmentHF
      parameters:
      - name: investorId
        in: path
        required: true
        description: Pass the Firm ID to be queried.
        schema:
          type: string
        x-position: 1
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Asatdate
        in: query
        description: Pass the as at date to be queried. Accepts a single date in the format YYYYMMDD.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: MonthlyReturnNetPct
        in: query
        description: Pass the monthly return net percentage to be queried. Accepts a single value in the range of -99.99 to 999.99
        schema:
          type: string
        x-position: 5
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestorCommitmentHFResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: No Results Found
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
      summary: Investor commitment commitment HF
      x-summary-source: derived
components:
  schemas:
    InvestorCommitmentREResponse:
      type: object
      additionalProperties: false
      properties:
        investorId:
          type: string
          description: Unique firm identifier
        investorName:
          type: string
          description: Unique firm identifier name
        fundId:
          type: string
          description: Unique fund identifier
        fundName:
          type: string
          description: Name of fund
        fundManagerId:
          type: string
          description: Id of firm
        fundManagerName:
          type: string
          description: Name of firm
        fundCurrency:
          type: string
          description: Fund Local Currency
        fundSizeMn:
          type: string
          description: Fund size in Fund Local Currency
        committedMn:
          type: string
          description: Committed amount in Fund Local Currency
        committedUsdMn:
          type: string
          description: Committed amount in USD Millions
        vintage:
          type: string
          description: The fund's first year of investment/capital call
        fundType:
          type: string
          description: Fund types used by the firm.
        primarySector:
          type: string
          description: Main sector targeted by the fund
        domicile:
          type: string
          description: Location the fund is domiciled in
        benchmarkLocations:
          type: string
          description: Location of the benchmark that the fund is part of
        managerExperience:
          type: string
          description: Number of funds the manager has raised
    DocumentOfInvestorCommitmentNRResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestorCommitmentNRResponse'
    DocumentOfInvestorCommitmentINFResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestorCommitmentINFResponse'
    DocumentOfInvestorCommitmentPDResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestorCommitmentPDResponse'
    InvestorCommitmentPDResponse:
      type: object
      additionalProperties: false
      properties:
        investorId:
          type: string
          description: Unique firm identifier
        investorName:
          type: string
          description: Unique firm identifier name
        fundId:
          type: string
          description: Unique fund identifier
        fundName:
          type: string
          description: Name of fund
        fundManagerId:
          type: string
          description: Id of firm
        fundManagerName:
          type: string
          description: Name of firm
        fundCurrency:
          type: string
          description: Fund Local Currency
        fundSizeMn:
          type: string
          description: Fund size in Fund Local Currency
        committedMn:
          type: string
          description: Committed amount in Fund Local Currency
        committedUsdMn:
          type: string
          description: Committed amount in USD Millions
        vintage:
          type: string
          description: The fund's first year of investment/capital call
        fundType:
          type: string
          description: Fund types used by the firm.
        coreIndustries:
          type: string
          description: Core industries that the firm invests in
        industryVerticals:
          type: string
          description: Target verticals the firm focuses on for its investments
        domicile:
          type: string
          description: Location the fund is domiciled in
        benchmarkLocations:
          type: string
          description: Location of the benchmark that the fund is part of
        managerExperience:
          type: string
          description: Number of funds the manager has raised
    DocumentOfInvestorCommitmentHFResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestorCommitmentHFResponse'
    DocumentOfInvestorCommitmentREResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestorCommitmentREResponse'
    InvestorCommitmentINFResponse:
      type: object
      additionalProperties: false
      properties:
        investorId:
          type: string
          description: Unique firm identifier
        investorName:
          type: string
          description: Unique firm identifier
        fundId:
          type: string
          description: Unique fund identifier
        fundName:
          type: string
          description: Name of fund
        fundManagerId:
          type: string
          description: Id of firm
        fundManagerName:
          type: string
          description: Name of firm
        fundCurrency:
          type: string
          description: Fund Local Currency
        fundSizeMn:
          type: string
          description: Fund size in Fund Local Currency
        committedMn:
          type: string
          description: Committed amount in Fund Local Currency
        committedUsdMn:
          type: string
          description: Committed amount in USD Millions
        vintage:
          type: string
          description: The fund's first year of investment/capital call
        fundType:
          type: string
          description: Fund types used by the firm.
        primarySector:
          type: string
          description: Main sector targeted by the fund
        benchmarkLocations:
          type: string
          description: Location of the benchmark that the fund is part of
        managerExperience:
          type: string
          description: Number of funds the manager has raised
    Metadata:
      type: object
      additionalProperties: false
      properties:
        total:
          type: integer
          description: Total number of records available for the query
          format: int64
        returned:
          type: integer
          description: Total number of records returned for the query
          format: int32
        page:
          type: integer
          description: Page number of the current query
          format: int32
    InvestorCommitmentPEResponse:
      type: object
      additionalProperties: false
      properties:
        investorId:
          type: string
          description: Unique firm identifier
        investorName:
          type: string
          description: Unique firm identifier name
        fundId:
          type: string
          description: Unique fund identifier
        fundName:
          type: string
          description: Name of fund
        fundManagerId:
          type: string
          description: Id of firm
        fundManagerName:
          type: string
          description: Name of firm
        fundCurrency:
          type: string
          description: Fund Local Currency
        fundSizeMn:
          type: string
          description: Fund size in Fund Local Currency
        committedMn:
          type: string
          description: Committed amount in Fund Local Currency
        committedUsdMn:
          type: string
          description: Committed amount in USD Millions
        vintage:
          type: string
          description: The fund's first year of investment/capital call
        fundType:
          type: string
          description: Fund types used by the firm.
        coreIndustries:
          type: string
          description: Core industries that the firm invests in
        industryVerticals:
          type: string
          description: Target verticals the firm focuses on for its investments
        domicile:
          type: string
          description: Location the fund is domiciled in
        benchmarkLocations:
          type: string
          description: Location of the benchmark that the fund is part of
        managerExperience:
          type: string
          description: Number of funds the manager has raised
    InvestorCommitmentHFResponse:
      type: object
      additionalProperties: false
      properties:
        investorId:
          type:
          - string
          - 'null'
          description: Unique firm identifier
        investorName:
          type: string
          description: Unique firm identifier name
        fundId:
          type: string
          description: Unique fund identifier
        fundName:
          type:
          - string
          - 'null'
          description: Name of fund
        fundManagerId:
          type: string
          description: Id of firm
        fundManagerName:
          type:
          - string
          - 'null'
          description: Name of firm
        currentRedeemed:
          type:
          - string
          - 'null'
          description: Status (current / redeemed)
        reportedFundSizeCurrency:
          type:
          - string
          - 'null'
          description: Currency used to report the fund size
        initialInvestmentSize:
          type:
          - string
          - 'null'
          description: Size of the initial investment
        initialInvestmentDate:
          type:
          - string
          - 'null'
          description: Date of the initial investment
        mostRecentValuation:
          type:
          - string
          - 'null'
          description: Most recent valuation of the fund
        mostRecentValuationDate:
          type:
          - string
          - 'null'
          description: Date of the most recent valuation
        fundType:
          type:
          - string
          - 'null'
          description: Fund types used by the firm.
        fundStructure:
          type:
          - string
          - 'null'
          description: The structure of the fund
        coreStrategy:
          type:
          - string
          - 'null'
          description: Primary strategy used by the fund
        inceptionDate:
          type:
          - string
          - 'null'
          description: The date a fund opened to investor capital. Preqin does not track funds that utilize only proprietary capital or pro-forma returns
        fundAumMn:
          type:
          - string
          - 'null'
          description: Most recently known fund net assets under management, reported in millions of fund local currency
        fundAumDate:
          type:
          - string
          - 'null'
          description: Date the assets under management of the fund class were reported
        twelveMonthsReturn:
          type:
          - string
          - 'null'
          description: Monthly returns used to calculate performance over longer timeframes (twelve months)
        asAtDate:
          type: string
          description: Fund details as of date/snapshot in time
    DocumentOfInvestorCommitmentPEResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestorCommitmentPEResponse'
    InvestorCommitmentNRResponse:
      type: object
      additionalProperties: false
      properties:
        investorId:
          type: string
          description: Unique firm identifier
        investorName:
          type: string
          description: Unique firm identifier name
        fundId:
          type: string
          description: Unique fund identifier
        fundName:
          type: string
          description: Name of fund
        fundManagerId:
          type: string
          description: Id of firm
        fundManagerName:
          type: string
          description: Name of firm
        fundCurrency:
          type: string
          description: Fund Local Currency
        fundSizeMn:
          type: string
          description: Fund size in Fund Local Currency
        committedMn:
          type: string
          description: Committed amount in Fund Local Currency
        committedUsdMn:
          type: string
          description: Committed amount in USD Millions
        vintage:
          type: string
          description: The fund's first year of investment/capital call
        benchmarkLocations:
          type: string
          description: Location of the benchmark that the fund is part of
        managerExperience:
          type: string
          description: Number of funds the manager has raised
  securitySchemes:
    bearer:
      type: http
      description: See the Authentication section of the documentation to obtain a token, and then paste it below
      scheme: Bearer
      bearerFormat: JWT
x-generator: NSwag v14.3.0.0 (NJsonSchema v11.2.0.0 (Newtonsoft.Json v13.0.0.0))