Preqin Investment Consultant API

openapi: 3.2.0
info:
  title: Operational API Documentation Investment Consultant API
  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: Investment Consultant
  description: Investment Consultant data and related information
paths:
  /api/InvestmentConsultant:
    get:
      tags:
      - Investment Consultant
      description: Investment Consultant data
      operationId: InvestmentConsultant_Get
      parameters:
      - name: ConsultantID
        in: query
        description: 'Pass the Consultant ID to be queried. Multiple Consultants can be queried in one call by passing comma-separated Consultant IDs.<BR><B>Example : </B><br>Single Consultant ID: 1<br>Multiple Consultant IDs: 1,2,3'
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: ConsultantName
        in: query
        description: Pass the Consultant Name to be queried. Partial Consultant Name search is supported.
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: Location
        in: query
        description: Filter by the Investment Consultant's location. We support country, region, state, and city-level filtering. Refer to the dropdown for a full list of supported values.
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: About
        in: query
        description: Filter by the Investment Consultant's About section. Partial search is supported; at least two characters are required.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 5
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 6
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestmentConsultantResponse'
        '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: Investment consultant get
      x-summary-source: derived
  /api/InvestmentConsultant/Contact:
    get:
      tags:
      - Investment Consultant
      description: Investment Consultant Contact data
      operationId: InvestmentConsultant_Contact
      parameters:
      - name: ConsultantId
        in: query
        description: 'Pass the Consultant ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Consultant IDs<BR><B>Example : </B><br>Single Consultant ID: 1<br>Multiple Consultant ID: 1,2,3'
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: ContactId
        in: query
        description: Pass the Contact ID to be queried. Multiple contacts can be queried in one call by passing comma-separated Contact IDs<BR>
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: ContactName
        in: query
        description: Pass the name of the contact to be queried. Partial contact name search is supported.
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 4
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 5
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestmentConsultantContactResponse'
        '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: Investment consultant contact
      x-summary-source: derived
  /api/InvestmentConsultant/address:
    get:
      tags:
      - Investment Consultant
      description: Investment consultant Address data
      operationId: InvestmentConsultant_Address
      parameters:
      - name: ConsultantId
        in: query
        description: 'Pass the Consultant ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Consultant IDs<BR><B>Example : </B><br>Single Firm ID: 1'
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: Region
        in: query
        description: Apply a filter to restrict the response by Region filter. Refer to the dropdown for a full list of supported values.
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 4
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestmentConsultantAddressResponse'
        '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: Investment consultant address
      x-summary-source: derived
  /api/InvestmentConsultant/knownclients:
    get:
      tags:
      - Investment Consultant
      description: Investment consultant Known clients data
      operationId: InvestmentConsultant_KnownClients
      parameters:
      - name: ConsultantID
        in: query
        description: 'Pass the Consultant ID to be queried. Multiple Consultants can be queried in one call by passing comma-separated Consultant IDs<BR><B>Example : </B><br>Single Consultant ID: 1<br>Multiple Consultant IDs: 1,2,3'
        schema:
          type:
          - string
          - 'null'
        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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfInvestmentConsultantKnownClientsResponse'
        '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: Investment consultant known clients
      x-summary-source: derived
components:
  schemas:
    DocumentOfInvestmentConsultantKnownClientsResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestmentConsultantKnownClientsResponse'
    InvestmentConsultantContactResponse:
      allOf:
      - $ref: '#/components/schemas/CommonContactsResponse'
      - type: object
        additionalProperties: false
        properties:
          consultantId:
            type:
            - string
            - 'null'
            description: Unique ID for the firm the consultant is part of
          consultantName:
            type:
            - string
            - 'null'
            description: Name of Consultant
          firmType:
            type:
            - string
            - 'null'
            description: Type of investor the contact works for
    DocumentOfInvestmentConsultantContactResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestmentConsultantContactResponse'
    DocumentOfInvestmentConsultantResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestmentConsultantResponse'
    InvestmentConsultantResponse:
      type: object
      additionalProperties: false
      properties:
        consultantId:
          type: string
          description: Unique ID for the firm the consultant is part of
        consultantName:
          type: string
          description: Name of Consultant
        city:
          type: string
          description: City of consultant
        country:
          type: string
          description: Country of consultant
        totalNoOfClients:
          type: string
          description: Total number of all clients the consultant consults for
        assetClassCoverage:
          type: string
          description: Asset classes the consultant consults within
        region:
          type: string
          description: Region the Consultant is based in
        address:
          type: string
          description: Address of consultant
        stateCounty:
          type: string
          description: State of consultant
        zipCode:
          type: string
          description: Zip code of consultant
        website:
          type: string
          description: URL website of consultant
        email:
          type: string
          description: Email address of consultant
        tel:
          type: string
          description: Telephone number of consultant
        preferredMethodOfInitialContact:
          type: string
          description: Preferred method the consultant would like to be contact
        preferredContactEmail:
          type: string
          description: Preferred email address the consultant would like to be contacted on
        assetsUnderAdvisementCurrMn:
          type: string
          description: Total number of assets under advisement in the Local currency in millions
        assetsUnderAdvisementUSDMn:
          type: string
          description: Total number of assets under advisement in the USD currency in millions
        assetsUnderAdvisementEURMn:
          type: string
          description: Total number of assets under advisement in the EUR currency in millions
        alternativeAuaCurrMn:
          type: string
          description: Total number of alternative assets under advisement in Local currency in millions
        alternativeAuaUSDMn:
          type: string
          description: Total number of alternative assets under advisement in USD currency in millions
        alternativeAuaEURMn:
          type: string
          description: Total number of alternative assets under advisement in EUR currency in millions
        discretionaryAuaCurrMn:
          type: string
          description: Total number of discretionary assets under advisement in Local currency in millions
        discretionaryAuaUSDMn:
          type: string
          description: Total number of discretionary assets under advisement in USD currency in millions
        discretionaryAuaEURMn:
          type: string
          description: Total number of discretionary assets under advisement in EUR currency in millions
        nonDiscretionaryAuaCurrMn:
          type: string
          description: Total number of non-discretionary assets under advisement in Local currency in millions
        nonDiscretionaryAuaUSDMn:
          type: string
          description: Total number of non-discretionary assets under advisement in USD currency in millions
        nonDiscretionaryAuaEURMn:
          type: string
          description: Total number of non-discretionary assets under advisement in EUR currency in millions
        privateEquityAuaCurrMn:
          type: string
          description: Private Equity Assets under advisement in Local currency in millions
        privateEquityAuaUSDMn:
          type: string
          description: Private Equity Assets under advisement in USD currency in millions
        privateEquityAuaEURMn:
          type: string
          description: Private Equity Assets under advisement in EUR currency in millions
        ventureCapitalCurrMn:
          type: string
          description: Venture Capital Assets under advisement in Local currency in millions
        ventureCapitalUSDMn:
          type: string
          description: Venture Capital Assets under advisement in USD currency in millions
        ventureCapitalEURMn:
          type: string
          description: Venture Capital Assets under advisement in EUR currency in millions
        realEstateAuaCurrMn:
          type: string
          description: Real Estate Assets under advisement in Local currency in millions
        realEstateAuaUSDMn:
          type: string
          description: Real Estate Assets under advisement in USD currency in millions
        realEstateAuaEURMn:
          type: string
          description: Real Estate Assets under advisement in EUR currency in millions
        hedgeFundsAuaCurrMn:
          type: string
          description: Hedge Funds Assets under advisement in Local currency in millions
        hedgeFundsAuaUSDMn:
          type: string
          description: Hedge Funds Assets under advisement in USD currency in millions
        hedgeFundsAuaEURMn:
          type: string
          description: Hedge Funds Assets under advisement in EUR currency in millions
        infrastructureAuaCurrMn:
          type: string
          description: Infrastructure Assets under advisement in Local currency in millions
        infrastructureAuaUSDMn:
          type: string
          description: Infrastructure Assets under advisement in USD currency in millions
        infrastructureAuaEURMn:
          type: string
          description: Infrastructure Assets under advisement in EUR currency in millions
        generalConsultantAuaCurrMn:
          type: string
          description: General Consultant Assets under advisement in Local currency in millions
        generalConsultantAuaUSDMn:
          type: string
          description: General Consultant Assets under advisement in USD currency in millions
        generalConsultantAuaEURMn:
          type: string
          description: General Consultant Assets under advisement in EUR currency in millions
        serviceCoverage:
          type: string
          description: If the consultant provides discretionary services, non-discretionary or both
        clientLocations:
          type: string
          description: Location of the clients the consultant provides services for
        clientTypes:
          type: string
          description: Types of clients the consultant provides their services for
        noOfAlternativeClients:
          type: string
          description: Total number of alternatives clients the consultant consults for
        about:
          type: string
          description: About section of the consultant
        privateDebtAuaCurrMn:
          type: string
          description: Private Debt under advisement in Local currency in millions
        privateDebtAuaUSDMn:
          type: string
          description: Private Debt under advisement in USD currency in millions
        privateDebtAuaEURMn:
          type: string
          description: Private Debt under advisement in EUR currency in millions
    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
    CommonContactsResponse:
      type: object
      additionalProperties: false
      properties:
        contactId:
          type:
          - string
          - 'null'
          description: Unique identifier of a contact
        title:
          type:
          - string
          - 'null'
          description: Contact title
        contactName:
          type:
          - string
          - 'null'
          description: Contact full name
        firstName:
          type:
          - string
          - 'null'
          description: Contact first name
        lastName:
          type:
          - string
          - 'null'
          description: Contact last name
        localLanguageName:
          type:
          - string
          - 'null'
          description: Local Language Name
        jobTitle:
          type:
          - string
          - 'null'
          description: Contact job title
        email:
          type:
          - string
          - 'null'
          description: Contact email address
        tel:
          type:
          - string
          - 'null'
          description: Contact telephone number
        linkedIn:
          type:
          - string
          - 'null'
          description: LinkedIn
        city:
          type:
          - string
          - 'null'
          description: City
        state:
          type:
          - string
          - 'null'
          description: State
        country:
          type:
          - string
          - 'null'
          description: Country
        zipCode:
          type:
          - string
          - 'null'
          description: 'Contact zip code/post code '
        assetClass:
          type:
          - string
          - 'null'
          description: Asset class(es) associated to the contact, comma separated
    DocumentOfInvestmentConsultantAddressResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InvestmentConsultantAddressResponse'
    InvestmentConsultantAddressResponse:
      type: object
      additionalProperties: false
      properties:
        consultantId:
          type: string
          description: Unique fund identifier
        consultantName:
          type: string
          description: Name of Consultant
        address:
          type: string
          description: Street address of firm
        city:
          type: string
          description: City firm's main office is based
        state:
          type: string
          description: State or county of the firm's office
        country:
          type: string
          description: Country of the firm's office
        zipCode:
          type: string
          description: Zip code/post code of the firm's office
        region:
          type: string
          description: Region of the firm's office
        tel:
          type: string
          description: Telephone number of the firm's office
        fax:
          type: string
          description: Fax number of the firm's office
        isHQ:
          type: string
          description: Headquarter of the firm
        map:
          type: string
          description: Map URL of the firm's office
    InvestmentConsultantKnownClientsResponse:
      type: object
      additionalProperties: false
      properties:
        consultantId:
          type: string
          description: Unique ID for the firm the consultant is part of
        consultantName:
          type: string
          description: Name of Consultant
        firmId:
          type: string
          description: Client ID
        firmName:
          type: string
          description: Client Name
        investorType:
          type: string
          description: Investor Type
        clientStatus:
          type: string
          description: Client Status
        location:
          type: string
          description: Location
        assetClassesAdvised:
          type: string
          description: Asset Classes Advised
  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))