{
  "opencollection": "1.0.0",
  "info": {
    "name": "Factset Analytics Datastore About Files API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Files",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Historical Audio Recordings and Related Metadata Within Factset Coverage.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/docs-distributor/audio/v1/history-files",
            "params": [
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the number of results to return per page. [ Min=0 ; Max=500 ]"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results."
              },
              {
                "name": "year",
                "value": "2021",
                "type": "query",
                "description": "Specifies the year for which the historical audio recordings and related metadata are to be retrieved."
              },
              {
                "name": "trimmed",
                "value": "true",
                "type": "query",
                "description": "Specifies if trimmed/untrimmed historical audio recordings should be returned."
              }
            ]
          },
          "docs": "\n* Returns the **untrimmed** historical audio recordings and related metadata dating back from May 10, 2011 to Sep 30, 2022.\n\n* Returns the **trimmed** historical audio recordings and related metadata dating back from May 10, 2011 to Dec 31, 2022.\n\n\n\nQuery parameters can be used to filter and narrow down the results.\n"
        },
        {
          "info": {
            "name": "Retrieve Latest Audio Recordings and Related Metadata Within Factset Coverage.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/docs-distributor/audio/v1/list-files",
            "params": [
              {
                "name": "_sort",
                "value": "",
                "type": "query",
                "description": "Sorts results in chronological order, reverse chronological order and by uploadTime(latest uploaded first). Results are in reverse chronological order by default."
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the number of results to return per page. [ Min=0 ; Max=500 ]"
              },
              {
                "name": "startDate",
                "value": "2022-01-01T00:00:00.000Z",
                "type": "query",
                "description": "Used in conjuction with endDate. The earliest date of the audio file the API should fetch for (can be in absolute: **YYYY-MM-DD** or relative date: **-1** for yesterday)."
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results."
              },
              {
                "name": "endDate",
                "value": "2022-06-01T00:00:00.000Z",
                "type": "query",
                "description": "Used in conjuction with startDate. The latest date of the audio file the API should fetch for (can be in absolute: **YYYY-MM-DD** or relative date: **0** for today)."
              },
              {
                "name": "reportId",
                "value": "2666621",
                "type": "query",
                "description": "Unique identifier for fetching the audio file for an event. The same ID is used for the transcript of the same event."
              },
              {
                "name": "audioSourceId",
                "value": "",
                "type": "query",
                "description": "Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (phone or webcast or vendor or replay). One ReportID can have multiple AudioSourceIDs."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "This parameter filters the results based on ticker-region or Entity ID or the combination of both. A comma is used to separate each identifier."
              },
              {
                "name": "sourceCode",
                "value": "",
                "type": "query",
                "description": "This parameter filters the results based on Source of the Audio file. Below are the descriptions for each Source Code -\n* P = Phone\n* W = Webcast\n* V = Vendor\n* I = Webcast Replay\n* F = Flash - identical to webcast; can merge with \"W\" in the future\n* R = Replay (Phone Replay)"
              },
              {
                "name": "fileName",
                "value": "835A1FD9-3CE1-EC11-8128-8CDCD4AF21E4.mp3",
                "type": "query",
                "description": "This parameter is used to filter the data on based on the file name."
              },
              {
                "name": "trimmed",
                "value": "",
                "type": "query",
                "description": "This parameters helps to search trimmed audio files."
              },
              {
                "name": "uploadTime",
                "value": "",
                "type": "query",
                "description": "This parameter filters data based on uploadTime relative to the current time, in hours. For example:- uploadTime = -15 (fetches audio files between 15 hours ago and now)\n\nMinimum is 1 hour i.e., uploadTime= -1\n\nMaximum is 1 week/168 hours i.e., uploadTime=-168\n\nWhile using uploadTime, the startDate and endDate parameters will be ignored."
              }
            ]
          },
          "docs": "Returns the latest audio recordings. Query parameters can be used to filter and narrow down the results."
        },
        {
          "info": {
            "name": "Factset Starts a File Upload",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/analytics/quant/fpe/v1/files/:server/:file",
            "params": [
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server to upload the file to. Either `interactive` or `batch`."
              },
              {
                "name": "file",
                "value": "",
                "type": "path",
                "description": "The file name to upload the file to. Existing directory can be specified."
              }
            ]
          },
          "docs": "This endpoint takes a file and uploads it"
        },
        {
          "info": {
            "name": "Factset Get Upload Status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/analytics/quant/fpe/v1/files/uploads/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "From url, provided by location header or response body in the upload start endpoint"
              }
            ]
          },
          "docs": "This is the endpoint to check on the progress of a previous upload request."
        },
        {
          "info": {
            "name": "Factset Returns the Jobid",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/streetaccount/historical/request-files",
            "params": [
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "Date from which data is required. Should be YYYY-MM-DDTHH:MM:SSZ format"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "The date until which the data is to be fetched. Should be YYYY-MM-DDTHH:MM:SSZ format"
              }
            ]
          },
          "docs": "Give the startDate and endDate parameters as request parameters in the /request-files endpoint, it returns the jobID. startDate and endDate should be in YYYY-MM-DDTHH:MM:SSZ format. This API only supports adhoc requests to retrieve historical files and does not support real-time files and if you interested in require real-time push should consider the other three methods (pushed via SFTP, to QNT account, or your Azure Storage). Per API request able to query till 2 years of data"
        },
        {
          "info": {
            "name": "Factset Returns the Streetaccount Xml Files for the Specified Date Range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/streetaccount/historical/get-files",
            "params": [
              {
                "name": "jobID",
                "value": "",
                "type": "query",
                "description": "jobID returned by the request-files endpoint to collect the results of the query"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to return per result"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the   beginning of next set of results"
              }
            ]
          },
          "docs": "Need to plug-in the jobID from /check-status into /get-files endpoint"
        },
        {
          "info": {
            "name": "Factset Requests the Creation of Tick-by-tick File",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/level1/files/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Data available from 20120101 to previous day."
        },
        {
          "info": {
            "name": "Factset Returns the Status of the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level1/files/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect status of the query"
              }
            ]
          },
          "docs": "Need to plug-in the id get from /create endpoint into /status endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Tick-by-tick Data in Files Requested in the /create Endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level1/files/get",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect results of the query"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to return per response page"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results"
              }
            ]
          },
          "docs": "Returns the files from tickhistory endpoint"
        },
        {
          "info": {
            "name": "Factset Requests the Creation of Minute Bars File",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/level1/files/minute-bars/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "1-minute bars available from 20120101 to previous day. Per request able to fetch upto 6 months of data."
        },
        {
          "info": {
            "name": "Factset Returns the Status of the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level1/files/minute-bars/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect status of the query"
              }
            ]
          },
          "docs": "Need to plug-in the id get from /create endpoint into /status endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Minute Bars Data in Files Requested in the /create Endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level1/files/minute-bars/get",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect results of the query"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to return per response page"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results"
              }
            ]
          },
          "docs": "Returns the files from tickhistory endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Id for the Requested Data.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.factset.com/level2/files/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Data available from past 6 years to previous day."
        },
        {
          "info": {
            "name": "Factset Returns the Status of the Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level2/files/status",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect status of the query"
              }
            ]
          },
          "docs": "Need to plug-in the id get from /create endpoint into /status endpoint"
        },
        {
          "info": {
            "name": "Factset Returns the Tick History Files Requested in the /create Endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.factset.com/level2/files/get",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "id returned by files create endpoint to poll and collect results of the query"
              },
              {
                "name": "_paginationLimit",
                "value": "",
                "type": "query",
                "description": "Specifies the maximum number of results to return per response page"
              },
              {
                "name": "_paginationOffset",
                "value": "",
                "type": "query",
                "description": "Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results"
              }
            ]
          },
          "docs": "Returns the files from tickhistory endpoint"
        }
      ]
    }
  ],
  "bundled": true
}