FactSet Entity API — Factset Entity

naftiko: 1.0.0-alpha2
info:
  label: FactSet Entity API — Factset Entity
  description: 'FactSet Entity API — Factset Entity. 12 operations. Lead operation: Factset Returns entity reference data
    in Chinese for an individual entity.. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Factset Entity
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: entity-factset-entity
    baseUri: https://api.factset.com/content
    description: FactSet Entity API — Factset Entity business capability. Self-contained, no shared references.
    resources:
    - name: factset-entity-v1-entity-reference-chi
      path: /factset-entity/v1/entity-reference-chi
      operations:
      - name: getentityreferencechi
        method: GET
        description: Factset Returns entity reference data in Chinese for an individual entity.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getentityreferencechiforlist
        method: POST
        description: Factset Returns entity reference data in Chinese for an individual entity.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-entity-v1-entity-references
      path: /factset-entity/v1/entity-references
      operations:
      - name: getentityreferences
        method: GET
        description: Factset Returns an entity reference profiles for an individual entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postentityreferences
        method: POST
        description: Factset Returns an entity reference data for a list of ids.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-entity-v1-entity-securities
      path: /factset-entity/v1/entity-securities
      operations:
      - name: getentitysecurities
        method: GET
        description: Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postentitysecurities
        method: POST
        description: Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-entity-v1-entity-structures
      path: /factset-entity/v1/entity-structures
      operations:
      - name: getentitystructure
        method: GET
        description: Factset Returns all active or inactive entities and respective levels below the requested entity id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postentitystructure
        method: POST
        description: Factset Returns all active or inactive entities below the requested entity id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-entity-v1-hist-credit-parent
      path: /factset-entity/v1/hist-credit-parent
      operations:
      - name: gethistcredparent
        method: GET
        description: Factset Returns historical credit parents for the requested id(s).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: posthistcredparent
        method: POST
        description: Factset Returns historical credit parents for the requested id(s).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: factset-entity-v1-ultimate-entity-structures
      path: /factset-entity/v1/ultimate-entity-structures
      operations:
      - name: getultimateentitystructure
        method: GET
        description: Factset Returns the full ultimate parent entity hiearachy. Control levels and active status of underlying
          entities.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postultimateentitystructure
        method: POST
        description: Factset Returns all active or inactive entities and respective levels below the requested entity id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: entity-factset-entity-rest
    port: 8080
    description: REST adapter for FactSet Entity API — Factset Entity. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/factset-entity/v1/entity-reference-chi
      name: factset-entity-v1-entity-reference-chi
      description: REST surface for factset-entity-v1-entity-reference-chi.
      operations:
      - method: GET
        name: getentityreferencechi
        description: Factset Returns entity reference data in Chinese for an individual entity.
        call: entity-factset-entity.getentityreferencechi
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getentityreferencechiforlist
        description: Factset Returns entity reference data in Chinese for an individual entity.
        call: entity-factset-entity.getentityreferencechiforlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-entity/v1/entity-references
      name: factset-entity-v1-entity-references
      description: REST surface for factset-entity-v1-entity-references.
      operations:
      - method: GET
        name: getentityreferences
        description: Factset Returns an entity reference profiles for an individual entity
        call: entity-factset-entity.getentityreferences
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postentityreferences
        description: Factset Returns an entity reference data for a list of ids.
        call: entity-factset-entity.postentityreferences
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-entity/v1/entity-securities
      name: factset-entity-v1-entity-securities
      description: REST surface for factset-entity-v1-entity-securities.
      operations:
      - method: GET
        name: getentitysecurities
        description: Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
        call: entity-factset-entity.getentitysecurities
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postentitysecurities
        description: Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
        call: entity-factset-entity.postentitysecurities
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-entity/v1/entity-structures
      name: factset-entity-v1-entity-structures
      description: REST surface for factset-entity-v1-entity-structures.
      operations:
      - method: GET
        name: getentitystructure
        description: Factset Returns all active or inactive entities and respective levels below the requested entity id.
        call: entity-factset-entity.getentitystructure
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postentitystructure
        description: Factset Returns all active or inactive entities below the requested entity id.
        call: entity-factset-entity.postentitystructure
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-entity/v1/hist-credit-parent
      name: factset-entity-v1-hist-credit-parent
      description: REST surface for factset-entity-v1-hist-credit-parent.
      operations:
      - method: GET
        name: gethistcredparent
        description: Factset Returns historical credit parents for the requested id(s).
        call: entity-factset-entity.gethistcredparent
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: posthistcredparent
        description: Factset Returns historical credit parents for the requested id(s).
        call: entity-factset-entity.posthistcredparent
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/factset-entity/v1/ultimate-entity-structures
      name: factset-entity-v1-ultimate-entity-structures
      description: REST surface for factset-entity-v1-ultimate-entity-structures.
      operations:
      - method: GET
        name: getultimateentitystructure
        description: Factset Returns the full ultimate parent entity hiearachy. Control levels and active status of underlying
          entities.
        call: entity-factset-entity.getultimateentitystructure
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postultimateentitystructure
        description: Factset Returns all active or inactive entities and respective levels below the requested entity id.
        call: entity-factset-entity.postultimateentitystructure
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: entity-factset-entity-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Entity API — Factset Entity. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-returns-entity-reference-data
      description: Factset Returns entity reference data in Chinese for an individual entity.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entity-factset-entity.getentityreferencechi
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-entity-reference-data-2
      description: Factset Returns entity reference data in Chinese for an individual entity.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: entity-factset-entity.getentityreferencechiforlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-entity-reference-profiles
      description: Factset Returns an entity reference profiles for an individual entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entity-factset-entity.getentityreferences
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-entity-reference-data-3
      description: Factset Returns an entity reference data for a list of ids.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: entity-factset-entity.postentityreferences
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-all-equity-exchange
      description: Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entity-factset-entity.getentitysecurities
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-all-equity-exchange-2
      description: Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: entity-factset-entity.postentitysecurities
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-all-active-inactive
      description: Factset Returns all active or inactive entities and respective levels below the requested entity id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entity-factset-entity.getentitystructure
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-all-active-inactive-2
      description: Factset Returns all active or inactive entities below the requested entity id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: entity-factset-entity.postentitystructure
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-historical-credit-parents
      description: Factset Returns historical credit parents for the requested id(s).
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entity-factset-entity.gethistcredparent
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-historical-credit-parents-2
      description: Factset Returns historical credit parents for the requested id(s).
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: entity-factset-entity.posthistcredparent
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-full-ultimate-parent
      description: Factset Returns the full ultimate parent entity hiearachy. Control levels and active status of underlying
        entities.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: entity-factset-entity.getultimateentitystructure
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-all-active-inactive-3
      description: Factset Returns all active or inactive entities and respective levels below the requested entity id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: entity-factset-entity.postultimateentitystructure
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.