Factset Bulk Documents API

openapi: 3.0.3
info:
  title: Factset Analytics Datastore About Bulk Documents API
  description: Allow clients to fetch precalculated Analytics through predeterministic URLs.
  contact:
    name: FactSet Research Systems
    url: https://developer.factset.com/contact
    email: api@factset.com
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.0.0
servers:
- url: https://api.factset.com
  description: Production
- url: https://api-sandbox.factset.com
  description: Sandbox
security:
- basicAuth: []
tags:
- name: Bulk Documents
paths:
  /bulk-documents/nrt/v1/calls:
    get:
      summary: Factset Returns the active calls happening at the moment.
      tags:
      - Bulk Documents
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NRT-Calls'
              examples:
                example-1:
                  value:
                    data:
                    - callStatus: inProgress
                      reportId: 2683372
                      sourceCode: W
                      audioSourceId: 471849
                      recordingStartTime: '2022-07-11T14:46:59Z'
                      ticker: AZZ-US
                      entityId: 000CGP-E
                      eventType: E
                      eventTitle: Q1 2023 Earnings Call
                      eventDatetimeUtc: '2022-07-11T15:00:00Z'
                    meta:
                      sort:
                      - -startDate
                      pagination:
                        total: 1
                        isEstimatedTotal: false
                        limit: 5
                        offset: 1
                      partial:
                        isPartial: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NRT-Calls-400-Response'
              examples:
                example-1:
                  value:
                    id: f815da1a-da7e-4b66-a4a4-59b5b7c9bea2
                    code: parameterError
                    title: '[''_paginatinLimit''] is not a valid parameter(s)'
                    details:
                      validParameters:
                        _sort:
                        - startDate
                        - -startDate
                        _paginationLimit:
                        - integer from 0 to 500
                        _paginationOffset:
                        - positive integer
                        audioSourceId:
                        - positive integer
                        reportId:
                        - positive integer
                        callStatus:
                        - ended
                        - inProgress
                        - ewn
                        - issueAtSource
                        ticker:
                        - string in form of 'ticker-region'
                        entityId:
                        - string
        '401':
          description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: notAuthenticated
                    title: There were either no, invalid, or expired credentials present in the request.
        '403':
          description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: notAuthorized
                    title: ' {USERNAME}-{SERIAL} does not have permission to use this endpoint.'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: genericServerError
                    title: An unexpected error happened.
      operationId: get-bulk-documents-nrt-v1-calls
      description: Returns the active calls happening at the moment
      parameters:
      - $ref: '#/components/parameters/paginationLimit'
      - $ref: '#/components/parameters/paginationOffset'
      - $ref: '#/components/parameters/audioSourceId1'
      - $ref: '#/components/parameters/reportId'
      - $ref: '#/components/parameters/callSort'
      - $ref: '#/components/parameters/entityId'
      - $ref: '#/components/parameters/ticker'
      - $ref: '#/components/parameters/callStatus'
  /bulk-documents/nrt/v1/list-snippets:
    get:
      summary: Factset Returns the latest transcript snippets from an active call.
      tags:
      - Bulk Documents
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NRT-Snippets'
              examples:
                example-1:
                  value:
                    data:
                    - reportId: 2683372
                      snippetEndTimestamp: '2021-10-15 13:16:50'
                      transcriptData:
                      - snippetData:
                          transcript: 'The operator will be with you shortly '
                          endTime: 3.78
                          startTime: 0
                      - snippetData:
                          transcript: ', welcomed the course call, please hold an operator will be with you shortly. '
                          endTime: 29.700000000000003
                          startTime: 21.42
                      snippetSequence: 1
                      audioSourceId: 471849
                    - reportId: 2683372
                      snippetEndTimestamp: '2021-10-15 13:17:16'
                      transcriptData:
                      - snippetData:
                          transcript: 'What Congress are looking to join '
                          endTime: 47.64
                          startTime: 41.46
                      - snippetData:
                          transcript: '. Can I have your first and name '
                          endTime: 55.32
                          startTime: 47.64
                      snippetSequence: 2
                      audioSourceId: 471849
                    - reportId: 2683372
                      snippetEndTimestamp: '2021-10-15 13:17:28'
                      transcriptData:
                      - snippetData:
                          transcript: '? Thank you. And good company '
                          endTime: 67.68
                          startTime: 61.2
                      snippetSequence: 3
                      audioSourceId: 471849
                    - reportId: 2683372
                      snippetEndTimestamp: '2021-10-15 13:17:41'
                      transcriptData:
                      - snippetData:
                          transcript: . Let's I'll join you and hold onto the calls again.
                          endTime: 74.46000000000001
                          startTime: 67.68
                      snippetSequence: 4
                      audioSourceId: 471849
                    - reportId: 2683372
                      snippetEndTimestamp: '2021-10-15 13:18:57'
                      transcriptData:
                      - snippetData:
                          transcript: 'on '
                          endTime: 156.78
                          startTime: 150.9
                      snippetSequence: 5
                      audioSourceId: 471849
                    meta:
                      pagination:
                        total: 191
                        isEstimatedTotal: false
                        limit: 5
                        offset: 5
                      partial:
                        isPartial: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NRT-Snippets-400-Response'
              examples:
                example-1:
                  value:
                    id: 39bf5f1c-c503-4787-94e0-e557a3564fd6,
                    code: parameterError
                    title: '[''_paginatinLimit''] is not a valid parameter(s)'
                    details:
                      validParameters:
                        _paginationLimit:
                        - integer from 0 to 500
                        _paginationOffset:
                        - positive integer
                        audioSourceId:
                        - positive integer
                        reportId:
                        - positive integer
        '401':
          description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: notAuthenticated
                    title: There were either no, invalid, or expired credentials present in the request.
        '403':
          description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: notAuthorized
                    title: ' {USERNAME}-{SERIAL} does not have permission to use this endpoint.'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: genericServerError
                    title: An unexpected error happened.
      operationId: get-bulk-documents-nrt-v1-list-snippets
      description: Returns the latest snippets from an active call
      parameters:
      - $ref: '#/components/parameters/paginationLimit'
      - $ref: '#/components/parameters/paginationOffset'
      - $ref: '#/components/parameters/audioSourceId'
      - $ref: '#/components/parameters/reportId'
  /bulk-documents/nrt/v1/speakerids:
    get:
      summary: Factset Returns the latest speakerIds with the confidence scores generated for an active call.
      tags:
      - Bulk Documents
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NRT-Speakerids'
              examples:
                example-1:
                  value:
                    data:
                    - audioSourceId: 471849
                      speakerStartOffset: 0
                      speakerId: 00797V-E
                      cosineScore: 0.6958988631392222
                      affiliationId: 0016YD-E
                    - audioSourceId: 471849
                      speakerStartOffset: 61.488
                      speakerId: 00797V-E
                      cosineScore: 0.7166958724380188
                      affiliationId: 0016YD-E
                    - audioSourceId: 471849
                      speakerStartOffset: 71.712
                      speakerId: 00797V-E
                      cosineScore: 0.7045775184563546
                      affiliationId: 0016YD-E
                    - audioSourceId: 471849
                      speakerStartOffset: 81.712
                      speakerId: 00797V-E
                      cosineScore: 0.7845775184563546
                      affiliationId: 0016YD-E
                    - audioSourceId: 471849
                      speakerStartOffset: 91.712
                      speakerId: 00797V-E
                      cosineScore: 0.7645775184563546
                      affiliationId: 0016YD-E
                    meta:
                      sort:
                      - startDate
                      pagination:
                        total: 439
                        isEstimatedTotal: false
                        limit: 5
                        offset: 5
                      partial:
                        isPartial: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NRT-Speakerids-400-Response'
              examples:
                example-1:
                  value:
                    id: caccf853-a448-4a14-b44f-ffbb962730f3
                    code: parameterError
                    title: '[''_paginatinLimit''] is not a valid parameter(s)'
                    details:
                      validParameters:
                        _sort:
                        - startDate
                        - -startDate
                        _paginationLimit:
                        - integer from 0 to 500
                        _paginationOffset:
                        - positive integer
                        audioSourceId:
                        - positive integer
        '401':
          description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: notAuthenticated
                    title: There were either no, invalid, or expired credentials present in the request.
        '403':
          description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: notAuthorized
                    title: ' {USERNAME}-{SERIAL} does not have permission to use this endpoint.'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                example-1:
                  value:
                    id: 7af3d86ca5954503b9244f2620fcf5eb
                    code: genericServerError
                    title: An unexpected error happened.
      operationId: get-bulk-documents-nrt-v1-speakerids
      parameters:
      - $ref: '#/components/parameters/paginationLimit'
      - $ref: '#/components/parameters/paginationOffset'
      - $ref: '#/components/parameters/audioSourceId'
      - $ref: '#/components/parameters/speakerSort'
      description: Returns the latest speakerIds with the cosine scores(confidence scores) generated for an active call.
  /bulk-documents/nrt/v1/indexed-nrt:
    get:
      summary: Factset Returns the  indexed transcript data  in small increments throughout the duration of an active call.
      tags:
      - Bulk Documents
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Indexed-NRT'
              examples:
                example-1:
                  value:
                    data:
                    - reportId: 2683372
                      snippetEndTimestamp: '2022-01-14 15:03:08'
                      snippetSequence: 7
                      audioSourceId: 471849
                      transcriptData:
                      - indexedData:
                        - index:
                          - confidence: 1
                            content: Revenue
                            language: en
                          endTime: 782.6299999976159
                          startTime: 782.1199999922515
                          type: word
                        - index:
                          - confidence: 0.9172338247299194
                            content: increased
                            language: en
                          endTime: 782.9899999523163
                          startTime: 782.6299999976159
                          type: word
                        - index:
                          - confidence: 0.9998389482498169
                            content: six
                            language: en
                          endTime: 783.2299999618531
                          startTime: 782.9899999523163
                          type: word
                        - index:
                          - confidence: 0.9989027976989746
                            content: percent
                            language: en
                          endTime: 783.7999383831025
                          startTime: 783.2299999618531
                          type: word
                        - index:
                          - confidence: 1
                            content: as
                            language: en
                          endTime: 784.0099999332429
                          startTime: 783.8000000143052
                          type: word
                        - index:
                          - confidence: 0.9140177965164185
                            content: we
                            language: en
                          endTime: 784.0999967479706
                          startTime: 784.0099999332429
                          type: word
                        - index:
                          - confidence: 0.8930811285972595
                            content: benefited
                            language: en
                          endTime: 784.6999999904633
                          startTime: 784.1026543998719
                          type: word
                        - index:
                          - confidence: 1
                            content: from
                            language: en
                          endTime: 784.9100000286103
                          startTime: 784.6999999904633
                          type: word
                        - index:
                          - confidence: 1
                            content: strong
                            language: en
                          endTime: 785.4499999904633
                          startTime: 784.9100546264649
                          type: word
                        - index:
                          - confidence: 1
                            content: gains
                            language: en
                          endTime: 786.3499998474122
                          startTime: 785.7499999427796
                          type: word
                        - index:
                          - confidence: 0.9999908208847046
                            content: from
                            language: en
                          endTime: 786.8299755477906
                          startTime: 786.5599998855591
                          type: word
                        - index:
                          - confidence: 0.9939011335372925
                            content: equity
                            language: en
                          endTime: 787.19
                          startTime: 786.8299998664857
                          type: word
                        - index:
                          - confidence: 0.9999626874923706
                            content: securities
                            language: en
                          endTime: 787.9399942779542
                          startTime: 787.1901826286316
                          type: word
                        - index:
                          - confidence: 1
                            content: and
                            language: en
                          endTime: 788.4499997520447
                          startTime: 788.1800994300843
                          type: word
                        - index:
                          - confidence: 0.6049093008041382
                            content: gain
                            language: en
                          endTime: 788.9599990272523
                          startTime: 788.4499997520447
                          type: word
                        - index:
                          - confidence: 1
                            content: from
                            language: en
                          endTime: 789.5299996757508
                          startTime: 789.2599996948243
                          type: word
                        - index:
                          - confidence: 0.9999662637710571
                            content: sales
                            language: en
                          endTime: 790.0999998474122
                          startTime: 789.5299996757508
                          type: word
                        - index:
                          - confidence: 1
                            content: of
                            language: en
                          endTime: 790.280000152588
                          startTime: 790.0999998474122
                          type: word
                        - index:
                          - confidence: 1
                            content: our
                            language: en
                          endTime: 790.3699993515015
                          startTime: 790.280000152588
                          type: word
                        - index:
                          - confidence: 0.999971866607666
                            content: student
                            language: en
                          endTime: 790.7000002288819
                          startTime: 790.3699993515015
                          type: word
                        - index:
                          - confidence: 0.9998940825462341
                            content: lending
                            language: en
                          endTime: 791.150000038147
                          startTime: 790.7000011825562
                          type: word
                        - index:
                          - confidence: 1
                            content: asset
                            language: en
                          endTime: 791.7499994659424
                          startTime: 791.2999996566773
                          type: word
                        snippetData:
                          transcript: 'Revenue increased six percent as we benefited from strong gains from equity securities and gain from sales of our student lending asset '
                          endTime: 791.75
                          startTime: 781.94
                    - reportId: 2683372
                      snippetEndTimestamp: '2022-01-14 15:03:28'
                      snippetSequence: 8
                      audioSourceId: 471849
                      transcriptData:
                      - indexedData:
                        - index:
                          - confidence: 1
                            content: management
                            language: en
                          endTime: 792.4099999666214
                          startTime: 791.7799999993294
                          type: word
                        - index:
                          - confidence: 0.9995142221450806
                            content: and
                            language: en
                          endTime: 792.589999973774
                          startTime: 792.4099999666214
                          type: word
                        - index:
                          - confidence: 1
                            content: corporate
                            language: en
                          endTime: 792.9199999570847
                          startTime: 792.589999973774
                          type: word
                        - index:
                          - confidence: 0.9906429052352905
                            content: trust
                            language: en
                          endTime: 793.2199999094009
                          startTime: 792.9199999570847
                          type: word
                        - index:
                          - confidence: 0.9990030527114868
                            content: businesses
                            language: en
                          endTime: 793.8563723564148
                          startTime: 793.2199999094009
                          type: word
                        - index:
                          - confidence: 1
                            content: .
                            language: en
                          endTime: 793.8563723564148
                          startTime: 793.8563723564148
                          isEOS: true
                          type: punctuation
                        - index:
                          - confidence: 1
                            content: We
                            language: en
                          endTime: 794.5999999046326
                          startTime: 794.3899998664856
                          type: word
                        - index:
                          - confidence: 1
                            content: also
                            language: en
                          endTime: 794.9299998283386
                          startTime: 794.5999999046326
                          type: word
                        - index:
                          - confidence: 0.8609960079193115
                            content: have
                            language: en
                          endTime: 795.0797309875488
                          startTime: 794.9299998283386
                          type: word
                        - index:
                          - confidence: 1
                            content: broad
                            language: en
                          endTime: 795.4099998474121
                          startTime: 795.079999923706
                          type: word
                        - index:
                          - confidence: 1
                            content: based
                            language: en
                          endTime: 795.7099997997284
                          startTime: 795.4099998474121
                          type: word
                        - index:
                          - confidence: 1
                            content: revenue
                            language: en
                          endTime: 796.0699996948242
                          startTime: 795.7099997997284
                          type: word
                        - index:
                          - confidence: 1
                            content: growth
                            language: en
                          endTime: 796.4899997711182
                          startTime: 796.0699996948242
                          type: word
                        - index:
                          - confidence: 1
                            content: across
                            language: en
                          endTime: 796.8800001144409
                          startTime: 796.4899997711182
                          type: word
                        - index:
                          - confidence: 1
                            content: our
                            language: en
                          endTime: 796.9699997901917
                          startTime: 796.8800001144409
                          type: word
                        - index:
                          - confidence: 1
                            content: businesses
                            language: en
                          endTime: 797.539999961853
                          startTime: 796.9699997901917
                          type: word
                        - index:
                          - confidence: 1
                            content: ','
                            language: en
                          endTime: 797.539999961853
                          startTime: 797.539999961853
                          isEOS: false
                          type: punctuation
                        - index:
                          - confidence: 1
                            content: including
                            language: en
                          endTime: 797.9600076675415
                          startTime: 797.539999961853
                          type: word
                        - index:
                          - confidence: 0.9997471570968628
                            content: home
                            language: en
                          endTime: 798.1699695587158
                          startTime: 797.9600076675415
                          type: word
                        - index:
                          - confidence: 0.9999999403953552
                            content: lending
                            language: en
                          endTime: 798.5899996757507
                          startTime: 798.170000076294
                          type: word
                        - index:
                          - confidence: 1
                            content: ','
                            language: en
                          endTime: 798.5899996757507
                          startTime: 798.5899996757507
                          isEOS: false
                          type: punctuation
                        - index:
                          - confidence: 0.9962349534034729
                            content: consumer
                            language: en
                          endTime: 799.4587783813477
                          startTime: 798.9800000190735
                          type: word
                        - index:
                          - confidence: 0.9955459237098694
                            content: and
                            language: en
                          endTime: 799.5499267578125
                          startTime: 799.4600353240967
                          type: word
                        - index:
                          - confidence: 1
                            content: small
                            language: en
                          endTime: 799.789999961853
                          startTime: 799.5499997138977
                          type: word
                        - index:
                          - con

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-bulk-documents-api-openapi.yml