naftiko: 1.0.0-alpha2
info:
  label: Factset IRN API v1 — Custom Symbols
  description: 'Factset IRN API v1 — Custom Symbols. 10 operations. Lead operation: Factset Get list of all custom symbols
    in your group along with some of their standard field and custom fields data. Self-contained Naftiko capability covering
    one Factset business surface.'
  tags:
  - Factset
  - Custom Symbols
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-custom-symbols-custom-symbols
    baseUri: https://api.factset.com/research/irn
    description: Factset IRN API v1 — Custom Symbols business capability. Self-contained, no shared references.
    resources:
    - name: v1-custom-symbols
      path: /v1/custom-symbols
      operations:
      - name: getcustomsymbols
        method: GET
        description: Factset Get list of all custom symbols in your group along with some of their standard field and custom
          fields data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: typeName
          in: query
          type: string
          description: filter custom symbols based on custom symbol type
        - name: query
          in: query
          type: string
          description: filter custom symbols based on custom symbol code or name
        - name: includeCustomFieldValues
          in: query
          type: boolean
          description: Whether or not to include customFieldValues
        - name: excludeLinkedCustomSymbol
          in: query
          type: boolean
          description: Whether or not to exclude linked custom symbol
        - name: includeEvent
          in: query
          type: boolean
          description: Whether or not to include event
      - name: createcustomsymbol
        method: POST
        description: Factset Create a custom symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-standard-symbol-metadata
      path: /v1/custom-symbols/standard-symbol-metadata
      operations:
      - name: createstandardsymbolmetadata
        method: POST
        description: Factset Create standard symbol metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-standard-symbol-metadata-standardSymbolId
      path: /v1/custom-symbols/standard-symbol-metadata/{standardSymbolId}
      operations:
      - name: patchstandardsymbol
        method: PATCH
        description: Factset Edit a standard symbol’s standard field and custom field data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: standardSymbolId
          in: path
          type: string
          description: standardSymbolId to update associated standard symbol
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-standard-symbol-metadata-standardSymbol
      path: /v1/custom-symbols/standard-symbol-metadata/{standardSymbol}
      operations:
      - name: getstandardsymbolmetadataguid
        method: GET
        description: Factset Get all custom field and standard field details on a specific standard symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: standardSymbol
          in: path
          type: string
          description: Standard symbol to get associated customSymbolId
          required: true
    - name: v1-custom-symbols-customSymbolId
      path: /v1/custom-symbols/{customSymbolId}
      operations:
      - name: getcustomsymbol
        method: GET
        description: Factset Get all custom field and standard field details on a specific custom symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId to get associated custom symbol
          required: true
        - name: includeEvent
          in: query
          type: boolean
          description: Whether or not to include event
      - name: patchcustomsymbol
        method: PATCH
        description: Factset Edit a custom symbol’s standard field and custom field data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId to update associated custom symbol
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecustomsymbol
        method: DELETE
        description: Factset Delete a custom symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId to delete associated custom symbol
          required: true
    - name: v1-custom-symbols-customSymbolId-link-standard-symbol
      path: /v1/custom-symbols/{customSymbolId}/link-standard-symbol
      operations:
      - name: linkcustomsymboltostandardsymbol
        method: POST
        description: Factset Link custom symbol to standard symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId associated with custom symbol
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-customSymbolId-records
      path: /v1/custom-symbols/{customSymbolId}/records
      operations:
      - name: getcustomsymbolrecords
        method: GET
        description: Factset Get all notes and meetings where a specific customSymbol was tagged as primary or related identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: CustomSymbolId to get associated records
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-custom-symbols-custom-symbols-rest
    port: 8080
    description: REST adapter for Factset IRN API v1 — Custom Symbols. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/custom-symbols
      name: v1-custom-symbols
      description: REST surface for v1-custom-symbols.
      operations:
      - method: GET
        name: getcustomsymbols
        description: Factset Get list of all custom symbols in your group along with some of their standard field and custom
          fields data
        call: irn-custom-symbols-custom-symbols.getcustomsymbols
        with:
          typeName: rest.typeName
          query: rest.query
          includeCustomFieldValues: rest.includeCustomFieldValues
          excludeLinkedCustomSymbol: rest.excludeLinkedCustomSymbol
          includeEvent: rest.includeEvent
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomsymbol
        description: Factset Create a custom symbol
        call: irn-custom-symbols-custom-symbols.createcustomsymbol
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/standard-symbol-metadata
      name: v1-custom-symbols-standard-symbol-metadata
      description: REST surface for v1-custom-symbols-standard-symbol-metadata.
      operations:
      - method: POST
        name: createstandardsymbolmetadata
        description: Factset Create standard symbol metadata
        call: irn-custom-symbols-custom-symbols.createstandardsymbolmetadata
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/standard-symbol-metadata/{standardsymbolid}
      name: v1-custom-symbols-standard-symbol-metadata-standardsymbolid
      description: REST surface for v1-custom-symbols-standard-symbol-metadata-standardSymbolId.
      operations:
      - method: PATCH
        name: patchstandardsymbol
        description: Factset Edit a standard symbol’s standard field and custom field data
        call: irn-custom-symbols-custom-symbols.patchstandardsymbol
        with:
          standardSymbolId: rest.standardSymbolId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/standard-symbol-metadata/{standardsymbol}
      name: v1-custom-symbols-standard-symbol-metadata-standardsymbol
      description: REST surface for v1-custom-symbols-standard-symbol-metadata-standardSymbol.
      operations:
      - method: GET
        name: getstandardsymbolmetadataguid
        description: Factset Get all custom field and standard field details on a specific standard symbol
        call: irn-custom-symbols-custom-symbols.getstandardsymbolmetadataguid
        with:
          standardSymbol: rest.standardSymbol
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/{customsymbolid}
      name: v1-custom-symbols-customsymbolid
      description: REST surface for v1-custom-symbols-customSymbolId.
      operations:
      - method: GET
        name: getcustomsymbol
        description: Factset Get all custom field and standard field details on a specific custom symbol
        call: irn-custom-symbols-custom-symbols.getcustomsymbol
        with:
          customSymbolId: rest.customSymbolId
          includeEvent: rest.includeEvent
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchcustomsymbol
        description: Factset Edit a custom symbol’s standard field and custom field data
        call: irn-custom-symbols-custom-symbols.patchcustomsymbol
        with:
          customSymbolId: rest.customSymbolId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomsymbol
        description: Factset Delete a custom symbol
        call: irn-custom-symbols-custom-symbols.deletecustomsymbol
        with:
          customSymbolId: rest.customSymbolId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/{customsymbolid}/link-standard-symbol
      name: v1-custom-symbols-customsymbolid-link-standard-symbol
      description: REST surface for v1-custom-symbols-customSymbolId-link-standard-symbol.
      operations:
      - method: POST
        name: linkcustomsymboltostandardsymbol
        description: Factset Link custom symbol to standard symbol
        call: irn-custom-symbols-custom-symbols.linkcustomsymboltostandardsymbol
        with:
          customSymbolId: rest.customSymbolId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/{customsymbolid}/records
      name: v1-custom-symbols-customsymbolid-records
      description: REST surface for v1-custom-symbols-customSymbolId-records.
      operations:
      - method: GET
        name: getcustomsymbolrecords
        description: Factset Get all notes and meetings where a specific customSymbol was tagged as primary or related identifier
        call: irn-custom-symbols-custom-symbols.getcustomsymbolrecords
        with:
          customSymbolId: rest.customSymbolId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-custom-symbols-custom-symbols-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset IRN API v1 — Custom Symbols. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-get-list-all-custom
      description: Factset Get list of all custom symbols in your group along with some of their standard field and custom
        fields data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-custom-symbols.getcustomsymbols
      with:
        typeName: tools.typeName
        query: tools.query
        includeCustomFieldValues: tools.includeCustomFieldValues
        excludeLinkedCustomSymbol: tools.excludeLinkedCustomSymbol
        includeEvent: tools.includeEvent
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-custom-symbol
      description: Factset Create a custom symbol
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-custom-symbols.createcustomsymbol
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-standard-symbol-metadata
      description: Factset Create standard symbol metadata
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-custom-symbols.createstandardsymbolmetadata
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-standard-symbol-s-standard
      description: Factset Edit a standard symbol’s standard field and custom field data
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-custom-symbols-custom-symbols.patchstandardsymbol
      with:
        standardSymbolId: tools.standardSymbolId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-custom-field
      description: Factset Get all custom field and standard field details on a specific standard symbol
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-custom-symbols.getstandardsymbolmetadataguid
      with:
        standardSymbol: tools.standardSymbol
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-custom-field-2
      description: Factset Get all custom field and standard field details on a specific custom symbol
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-custom-symbols.getcustomsymbol
      with:
        customSymbolId: tools.customSymbolId
        includeEvent: tools.includeEvent
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-custom-symbol-s-standard
      description: Factset Edit a custom symbol’s standard field and custom field data
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-custom-symbols-custom-symbols.patchcustomsymbol
      with:
        customSymbolId: tools.customSymbolId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-custom-symbol
      description: Factset Delete a custom symbol
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-custom-symbols-custom-symbols.deletecustomsymbol
      with:
        customSymbolId: tools.customSymbolId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-link-custom-symbol-standard
      description: Factset Link custom symbol to standard symbol
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-custom-symbols.linkcustomsymboltostandardsymbol
      with:
        customSymbolId: tools.customSymbolId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-notes-and
      description: Factset Get all notes and meetings where a specific customSymbol was tagged as primary or related identifier
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-custom-symbols.getcustomsymbolrecords
      with:
        customSymbolId: tools.customSymbolId
      outputParameters:
      - type: object
        mapping: $.