Preqin Service Provider API

openapi: 3.2.0
info:
  title: Operational API Documentation Service Provider 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: Service Provider
  description: Information about Service Providers, their deals, funds, contacts, and addresses.
paths:
  /api/ServiceProvider:
    get:
      tags:
      - Service Provider
      description: Fund Service Provider data
      operationId: ServiceProvider_Get
      parameters:
      - name: FirmID
        in: query
        description: 'Pass the Firm ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Firm IDs<BR><B>Example : </B><br>Single Firm ID: 1<br>Multiple Firm ID: 1,2,3'
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: ServiceProvider
        in: query
        description: Pass the Service Provider Name to be queried. Partial service Provider Name search is supported.
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: ServiceProviderGroup
        in: query
        description: 'Pass the Service Provider Group to be queried. Can be one of the following: ''fund'', ''transaction'''
        schema:
          type:
          - string
          - 'null'
        x-position: 3
      - name: ServiceProviderType
        in: query
        description: Pass the Service Provider Type to be queried.
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: Location
        in: query
        description: Filter by the Service Provider 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: 5
      - name: About
        in: query
        description: Filter by the Service Provider's About section. Partial search is supported, at least two characters are required.
        schema:
          type:
          - string
          - 'null'
        x-position: 6
      - name: Include
        in: query
        description: 'Add the asset class-specific data. Please note that you must have a valid subscription for the asset class in order for data to be returned. <BR><B>Example: </B><br>?include=pe,pd'
        schema:
          type: string
        x-position: 7
      - name: Page
        in: query
        description: Page number to fetch (default 1)
        schema:
          type: integer
          format: int32
        x-position: 8
      - name: Size
        in: query
        description: Number of records to fetch (default 200, Max 200)
        schema:
          type: integer
          format: int32
        x-position: 9
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentOfServiceProviderResponse'
        '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: Service provider get
      x-summary-source: derived
  /api/ServiceProvider/Deals:
    get:
      tags:
      - Service Provider
      description: Service Provider Deals data
      operationId: ServiceProvider_Deals
      parameters:
      - name: FirmID
        in: query
        description: 'Pass the Firm ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Firm IDs<BR><B>Example : </B><br>Single Firm ID: 1<br>Multiple Firm ID: 1,2,3'
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: ServiceProvider
        in: query
        description: Pass the Service Provider Name to be queried. Partial service Provider Name search is supported.
        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/DocumentOfServiceProviderDealsResponse'
        '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: Service provider deals
      x-summary-source: derived
  /api/ServiceProvider/Funds:
    get:
      tags:
      - Service Provider
      description: Service Provider Funds data
      operationId: ServiceProvider_Funds
      parameters:
      - name: FirmID
        in: query
        description: 'Pass the Firm ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Firm IDs<BR><B>Example : </B><br>Single Firm ID: 1<br>Multiple Firm ID: 1,2,3'
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: ServiceProvider
        in: query
        description: Pass the Service Provider Name to be queried. Partial service Provider Name search is supported.
        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/DocumentOfServiceProviderFundsLookupResponse'
        '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: Service provider funds
      x-summary-source: derived
  /api/ServiceProvider/Contact:
    get:
      tags:
      - Service Provider
      description: Service Provider Contact data
      operationId: ServiceProvider_Contact
      parameters:
      - name: FirmId
        in: query
        description: 'Pass the Firm ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Firm IDs<BR><B>Example : </B><br>Single Firm ID: 1<br>Multiple Firm 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.
        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: Email
        in: query
        description: Pass the email of the contact to be queried
        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/DocumentOfServiceProviderContactsResponse'
        '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: Service provider contact
      x-summary-source: derived
  /api/ServiceProvider/address:
    get:
      tags:
      - Service Provider
      description: Investor Address data
      operationId: ServiceProvider_Address
      parameters:
      - name: FirmId
        in: query
        description: 'Pass the Firm ID to be queried. Multiple Firms can be queried in one call by passing comma-separated Firm IDs<BR><B>Example : </B><br>Single Firm ID: 1<br>Multiple Firm ID: 1,2,3'
        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/DocumentOfServiceProviderAddressResponse'
        '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: Service provider address
      x-summary-source: derived
components:
  schemas:
    ServiceProviderContactsResponse:
      allOf:
      - $ref: '#/components/schemas/CommonContactsResponse'
      - type: object
        additionalProperties: false
        properties:
          firmId:
            type:
            - string
            - 'null'
            description: Unique Identifier for firm
          serviceProvider:
            type:
            - string
            - 'null'
            description: Name of Service Provider
          serviceProvideType:
            type:
            - string
            - 'null'
            description: Type of service(s) provided by Service Provider
    DocumentOfServiceProviderDealsResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceProviderDealsResponse'
    ServiceProviderAddressResponse:
      type: object
      additionalProperties: false
      properties:
        firmId:
          type: string
          description: Unique fund identifier
        serviceProvider:
          type: string
          description: Name of Service Provider
        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
    ServiceProviderResponse:
      type: object
      additionalProperties: false
      properties:
        firmID:
          type:
          - string
          - 'null'
          description: Unique Identifier for firm
        serviceProvider:
          type:
          - string
          - 'null'
          description: Name of Service Provider
        serviceProviderGroup:
          type:
          - string
          - 'null'
          description: Categorisation of Service Provider
        serviceProviderCategory:
          type:
          - string
          - 'null'
          description: Category of service(s) provided by Service Provider
        serviceProviderType:
          type:
          - string
          - 'null'
          description: Type of service(s) provided by Service Provider
        city:
          type: string
          description: City of Service Provider
        country:
          type: string
          description: Country of service provider
        region:
          type: string
          description: Geographic region of Service Provider
        address:
          type: string
          description: Street address of Service Provider
        stateCounty:
          type: string
          description: State of Service Provider
        zipCode:
          type: string
          description: Zip code of Service Provider
        website:
          type: string
          description: Website of Service Provider
        email:
          type: string
          description: Email of Service Provider
        tel:
          type: string
          description: Telephone number of Service Provider
        fax:
          type: string
          description: Fax number of service Provider
        about:
          type: string
          description: About of service Provider
        fund:
          description: Fund
          oneOf:
          - $ref: '#/components/schemas/ServiceProviderFundResponse'
        transaction:
          description: Transaction
          oneOf:
          - $ref: '#/components/schemas/ServiceProviderTransactionResponse'
    ServiceProviderTransactionResponse:
      type: object
      additionalProperties: false
      properties:
        investmentType:
          type: string
          description: InvestmentType
        projectStage:
          type: string
          description: ProjectStage
        dealStage:
          type: string
          description: DealStage
        assetCity:
          type: string
          description: AssetCity
        assetState:
          type: string
          description: AssetState
        assetCountry:
          type: string
          description: AssetCountry
        assetRegion:
          type: string
          description: AssetRegion
        noOfFinancialAdvisorDealsServiced:
          type: string
          description: NoOfFinancialAdvisorDealsServiced
        noOfLegalAdvisorDealsServiced:
          type: string
          description: NoOfLegalAdvisorDealsServiced
        noOfREBrokerDealsServiced:
          type: string
          description: NoOfREBrokerDealsServiced
        noOfDebtProviderDealsServiced:
          type: string
          description: NoOfDebtProviderDealsServiced
        primaryAssetType:
          type: string
          description: PrimaryAssetType
        assetTypes:
          type: string
          description: AssetTypes
    DocumentOfServiceProviderResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceProviderResponse'
    ServiceProviderFundResponse:
      type: object
      additionalProperties: false
      properties:
        domiciles:
          type:
          - string
          - 'null'
          description: Domiciles Service Provider is active in
        fundAdministrationServicesProvided:
          type: string
          description: Services provided by the Service Provider
        fundTypeAdvised:
          type:
          - string
          - 'null'
          description: Specific Fund types the Service Provider services
        knownNumberOfFundsServiced:
          type:
          - string
          - 'null'
          description: Total number of known funds the service provider has worked on all time.
        knownNumberOfFundsRaising:
          type:
          - string
          - 'null'
          description: Total number of known funds the service provider has worked on/is working on that are currently in market/raising capital.
        knownNumberOfFundsClosed:
          type:
          - string
          - 'null'
          description: Total number of known funds the service provider has worked on that are no longer in market/closed or liquidated.
        totalValueOfKnownFundsRaising:
          type:
          - string
          - 'null'
          description: Aggregate capital targeted by the known funds the service provider has worked on/ is working on that are currently in market/ raising capital.
        totalValueOfKnownFundsClosed:
          type:
          - string
          - 'null'
          description: Aggregate capital raised by the known funds that are closed or liquidated that the service provider has worked on.
        knownFundsClosedInLastYear:
          type:
          - string
          - 'null'
          description: Domiciles Service Provider is active inNumber of funds closed within the last calendar year
        knownFundsClosedInLast2Years:
          type:
          - string
          - 'null'
          description: Number of funds closed within the last 2 calendar years
        knownFundsClosedInLast3Years:
          type:
          - string
          - 'null'
          description: DNumber of funds closed within the last 3 calendar years
    DocumentOfServiceProviderAddressResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceProviderAddressResponse'
    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
    DocumentOfServiceProviderContactsResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceProviderContactsResponse'
    ServiceProviderDealsResponse:
      type: object
      additionalProperties: false
      properties:
        firmID:
          type: string
          description: FirmID
        serviceProvider:
          type:
          - string
          - 'null'
          description: ServiceProviderName
        serviceProviderType:
          type:
          - string
          - 'null'
          description: ServiceProviderType
        serviceProviderCategory:
          type:
          - string
          - 'null'
          description: Category of service(s) provided by Service Provider
        noOfDealsServiced:
          type:
          - string
          - 'null'
          description: NoOfDealsServiced
        dealID:
          type:
          - string
          - 'null'
          description: DealID
        dealName:
          type:
          - string
          - 'null'
          description: DealName
        dealDate:
          type:
          - string
          - 'null'
          description: DealDate
        dealType:
          type:
          - string
          - 'null'
          description: DealType
        dealStatus:
          type:
          - string
          - 'null'
          description: DealStatus
        dealSizeMn:
          type:
          - string
          - 'null'
          description: DealSizeMn
        industry:
          type:
          - string
          - 'null'
          description: Industry
        dealDescription:
          type:
          - string
          - 'null'
          description: DealDescription
    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
    ServiceProviderFundsLookupResponse:
      type: object
      additionalProperties: false
      properties:
        firmID:
          type: string
          description: FirmID
        serviceProvider:
          type:
          - string
          - 'null'
          description: Name of Service Provider
        serviceProviderType:
          type:
          - string
          - 'null'
          description: ServiceProviderType
        serviceProviderCategory:
          type:
          - string
          - 'null'
          description: Category of service(s) provided by Service Provider
        knownNumberofFundsServiced:
          type:
          - string
          - 'null'
          description: Total number of known funds the service provider has worked on all time.
        fundID:
          type:
          - string
          - 'null'
          description: FundID
        fundName:
          type:
          - string
          - 'null'
          description: FundName
        fundInceptionDateFundYear:
          type:
          - string
          - 'null'
          description: FundInceptionDateFundYear
        strategy:
          type:
          - string
          - 'null'
          description: Strategy
        primaryFundFocus:
          type:
          - string
          - 'null'
          description: PrimaryFundFocus
        status:
          type:
          - string
          - 'null'
          description: Status
        fundSizeMN:
          type:
          - string
          - 'null'
          description: FundSizeMN
        fundStructure:
          type:
          - string
          - 'null'
          description: FundStructure
        fundManagerHQ:
          type:
          - string
          - 'null'
          description: FundManagerHQ
        domicile:
          type:
          - string
          - 'null'
          description: Domicile
        fundOverview:
          type:
          - string
          - 'null'
          description: FundOverview
    DocumentOfServiceProviderFundsLookupResponse:
      type: object
      additionalProperties: false
      properties:
        meta:
          oneOf:
          - $ref: '#/components/schemas/Metadata'
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceProviderFundsLookupResponse'
  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))