{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Database API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Database", "type": "folder" }, "items": [ { "info": { "name": "Factset Gets the Latest Relative Rollover Date for the Database.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/factset-prices/v1/database-rollover" }, "docs": "Gets zero relative date and last update time for FactSet databases. The dates represent the date that the rollover event happened; the date and time is in **eastern time zone**.

Depending on the ids requested and their respective regions, a requested startDate or endDate used in the various Prices API may reflect different previous close dates. This relative \"zero\" date, meaning - as of yesterday's close - will vary across global regions. This API is designed to help production systems accou" }, { "info": { "name": "Factset Gets the Latest Relative Rollover Date for the Database.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/factset-prices/v1/database-rollover" }, "docs": "Gets zero relative date and last update time for FactSet databases. The dates represent the date that the rollover event happened; the date and time is in **eastern time zone**.

Depending on the ids requested and their respective regions, a requested startDate or endDate used in the various Prices API may reflect different previous close dates. This relative \"zero\" date, meaning - as of yesterday's close - will vary across global regions. This API is designed to help production systems accou" }, { "info": { "name": "getStatus", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/jobs/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the current status of a long running request. The full URL is normally provided for you in the Location header of a long running response." }, { "info": { "name": "getAudit", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/audit", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ] }, "docs": "Returns a list of the most recent \"modificationTimes\" in long datetime format" }, { "info": { "name": "getResourceAudit", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/audit/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "getStats", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/stats", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ] }, "docs": "Returns a summary of OFDB metadata and data points" }, { "info": { "name": "getResourceStats", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/stats/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "getFields", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/fields", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ] }, "docs": "Returns all the fields in the database(OFDB, OMS_OFDB, ECONOFDB)" }, { "info": { "name": "addFields", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/database/:path/fields", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows users to add fields to existing OFDBs" }, { "info": { "name": "getResourceFields", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/fields/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "deleteBulkItems", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/database/:path/delete", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows users to delete various combinations of symbols, dates, and fields from the desired OFDB" }, { "info": { "name": "getResourceBulkDelete", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/delete/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "getSymbols", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/symbols", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "startsWith", "value": "", "type": "query", "description": "Returns list of symbols which starts with mentioned string" }, { "name": "endsWith", "value": "", "type": "query", "description": "Returns list of symbols which ends with mentioned string" }, { "name": "contains", "value": "", "type": "query", "description": "Returns list of symbols which contains mentioned string" }, { "name": "equals", "value": "", "type": "query", "description": "Returns symbol which matches mentioned string" }, { "name": "orderBy", "value": "", "type": "query", "description": "Returns symbols in the mentioned sorted order, should provide asc or desc" } ] }, "docs": "Returns all the symbols in the database(OFDB, OMS_OFDB, ECONOFDB)" }, { "info": { "name": "addSymbols", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/database/:path/symbols", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new symbol with single/multiple dates for 3d database(OFDB). Creates a symbol for 2d database(OFDB)" }, { "info": { "name": "updateSymbols", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/database/:path/symbols", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates existing symbols for single/multiple dates or adds a new symbol/date within a symbol if not present in 3d database(OFDB). Updates an existing symbol field value or adds a new symbol if not present in the 2d database(OFDB)" }, { "info": { "name": "getResourceSymbols", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/symbols/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "updateSymbol", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/database/:path/symbols/:symbol", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "symbol", "value": "", "type": "path", "description": "Symbol with in the ofdb" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing symbol field value for single/multiple dates or adds a new symbol/date within a symbol if not present in 3d database(OFDB). Updates an existing symbol field value or adds a new symbol if not present in the 2d database(OFDB)" }, { "info": { "name": "deleteSymbol", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/database/:path/symbols/:symbol", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "symbol", "value": "", "type": "path", "description": "Symbol with in the ofdb" } ] }, "docs": "Deletes all data specific to the symbol in both 2d and 3d database(OFDB). This includes all the dates related to that symbols in 3d database(OFDB)" }, { "info": { "name": "getResourceSymbol", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/symbols/:symbol/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "symbol", "value": "", "type": "path", "description": "Symbol with in the ofdb" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "getDates", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/dates", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "between", "value": "", "type": "query", "description": "Returns list of dates which are between [start,end], dates should be in the respective order of start and end" }, { "name": "equals", "value": "", "type": "query", "description": "Returns the date which matches given date" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of dates which are before mentioned date" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of dates which are after mentioned date" }, { "name": "orderBy", "value": "", "type": "query", "description": "Returns dates in the mentioned sorted order, should provide asc or desc" } ] }, "docs": "Returns all the dates in the database(OFDB, OMS_OFDB, ECONOFDB)" }, { "info": { "name": "addDates", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/database/:path/dates", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new date with single/multiple symbols for a 3d database(OFDB)." }, { "info": { "name": "updateDates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/database/:path/dates", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates existing dates for single/multiple symbols or adds a new date/symbol within a date if not present in 3d database(OFDB)." }, { "info": { "name": "getResourceDates", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/dates/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "updateDate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/database/:path/dates/:date", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "date", "value": "", "type": "path", "description": "Date in YYYYMMDD format" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing date field value for single/multiple symbols or adds a new date/symbol within a date if not present in 3d database(OFDB)." }, { "info": { "name": "deleteDate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/database/:path/dates/:date", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "date", "value": "", "type": "path", "description": "Date in YYYYMMDD format" } ] }, "docs": "Deletes all data specific to the date in 3d database(OFDB). This includes all the symbols related to that date" }, { "info": { "name": "getResourceDate", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/dates/:date/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "date", "value": "", "type": "path", "description": "Date in YYYYMMDD format" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "deleteDateFromSymbol", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/database/:path/dates/:date/symbols/:symbol", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "date", "value": "", "type": "path", "description": "Date in YYYYMMDD format" }, { "name": "symbol", "value": "", "type": "path", "description": "Symbol with in the ofdb" } ] }, "docs": "Deletes data specific to the symbol and date from a 3d database(OFDB)." }, { "info": { "name": "getResourceDateFromSymbol", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/database/:path/dates/:date/symbols/:symbol/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "date", "value": "", "type": "path", "description": "Date in YYYYMMDD format" }, { "name": "symbol", "value": "", "type": "path", "description": "Symbol with in the ofdb" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Deletes data specific to the symbol and date from a 3d database(OFDB)." }, { "info": { "name": "getData", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "symbol", "value": "", "type": "query", "description": "Returns data for the symbol mentioned. e.g:sym1" }, { "name": "date", "value": "", "type": "query", "description": "Return data for the specific date or range of dates mentioned.e.g:[date1,date2]" }, { "name": "filterFields", "value": "", "type": "query", "description": "Can specify the fields on which you want to perform field filter operations e.g: [\"PRICE\",\"SECTOR\"]\n\nNote:\n\nThe request will respond with 400\n1. If fields which are not present on OFDB are given.\n2. If filterOps or filterValues query parameters are missing\n when filterFields is present.\n3. If number of values given for filterOps, \n filterFields, filterValues are different\n4. If exactly one of symbol or date query parameter is not provided.\n" }, { "name": "filterOps", "value": "", "type": "query", "description": "Can specify the field filter operations which you want to perform e.g: [\"LT\", \"GTEQ\", \"CT\"]\nin respective order of values in filterFields query parameter.\n\nThe available field filter operations are :\n\nFor CHAR type fields:\n\n\"CT\" : contains\n\n\"SW\" : starts-with\n\n\"EW\" : ends-with \n\n\"EQ\" : equals\n\nFor NUMERIC type fields:\n\n\"GT\" : greater than\n\n\"GTEQ\" : greater than or equals\n\n\"LT\" : lesser than\n\n\"LTEQ\" : lesser than or equals\n\n\"EQ\" : equals\n\nNote:\n\nThe request will respond with 400 \n1. If operations other than the above mentioned are provided.\n2. If numeric operations are given to char type fields instead of char operations.\n3. If char operations are given to numeric type fields instead of numeric operations.\n4. If filterFields or filterValues query parameters are missing\n when filterOps is present.\n5. If number of values given for filterOps, \n filterFields, filterValues are different\n6. If exactly one of symbol or date query parameter is not provided.\n" }, { "name": "filterValues", "value": "", "type": "query", "description": "Can specify the field filter values of the field filter operations e.g: [100, 20, \"AB\"]\nin respective order of values in filterFields and filterOps query parameters .\n\nNote: \n\nThe request will respond with 400\n1. If char values are given to numeric type fields.\n2. If filterFields or filterOps query parameters are missing\n when filterValues is present.\n3. If number of values given for filterOps, \n filterFields, filterValues are different\n4. If exactly one of symbol or date query parameter is not provided.\n" }, { "name": "filterDatesOps", "value": "", "type": "query", "description": "Can specify the date filter operations which you want to perform e.g: [\"LT\", \"GTEQ\"].\n\nThe available date filter operations are :\n\n\"GT\" : after\n\n\"GTEQ\" : after or equals\n\n\"LT\" : before\n\n\"LTEQ\" : before or equals\n\n\"EQ\" : equals\"\n\nNote:\n\nThe request will respond with 400 \n1. If operations other than the above mentioned are given.\n2. If filterDatesValues query parameter is missing when filterDatesOps is present.\n3. If number of values given for filterDatesOps and filterDatesValues differ.\n4. If symbol query parameter is not provided.\n" }, { "name": "filterDatesValues", "value": "", "type": "query", "description": "Can specify the date filter values of the date filter operations e.g: [20200505, 20200303]\nin respective order of values in filterDatesOps query parameter.\n\nNote:\n\nThe request will respond with 400\n1. If invalid date values are given\n2. If filterDatesOps query parameter is missing when filterDatesValues is present.\n3. If number of values given for filterDatesOps and filterDatesValues differ.\n4. If symbol query parameter is not provided.\n" }, { "name": "filterSymbolsOps", "value": "", "type": "query", "description": "Can specify the symbol filter operations which you want to perform e.g: [\"CT\", \"SW\"].\n\nThe available symbol filter operations are:\n\n\"SW\" : starts-with\n\n\"EW\" : ends-with\n\n\"CT\" : contains\n\n\"EQ\" : equals\n\nNote:\n\nThe request will respond with 400\n1. If operations other than the above mentioned are given.\n2. If filterSymbolsValues query parameter is missing when filterSymbolsOps is present.\n3. If number of values given for filterSymbolsOps and filterSymbolsValues differ.\n4. If date query parameter is not provided.\n" }, { "name": "filterSymbolsValues", "value": "", "type": "query", "description": "Can specify the symbol filter values of the date filter operations e.g: [\"ab\", \"xy\"]\nin respective order of values in filterSymbolsOps query parameter.\n\nNote:\nThe request will respond with 400\n1. If filterSymbolsOps query parameter is missing when filterSymbolsValues is present.\n2. If number of values given for filterSymbolsOps and filterSymbolsValues differ.\n3. If date query parameter is not provided.\n" }, { "name": "sortFieldName", "value": "", "type": "query", "description": "Can specify the name of field with respect to which user wants to sort data \n\nNote:\nThe request will respond with 400, If a field which doesn't exist in the OFDB is requested" }, { "name": "sortFieldOrder", "value": "", "type": "query", "description": "Can specify the order in which user wants to sort data with respect to sortFieldName query parameter \n\nNote:\nThe request will respond with 400, If value other than asc or desc is requested" } ] }, "docs": "Returns the data in the database(OFDB, OMS_OFDB, ECONOFDB) for the mentioned Symbol or Date. Atleast one parameter(Symbol/Date) is required. For a range of dates symbol parameter is mandatory." }, { "info": { "name": "getResourceData", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/:path/jobs/:id", "params": [ { "name": "path", "value": "", "type": "path", "description": "Encode database path" }, { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." }, { "info": { "name": "createDatabase", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/database", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a 2d or 3d database(OFDB). Users will note that not every field requires all the parameters listed in the schema. Please review FactSet data types on the OA for further guidance." }, { "info": { "name": "getResourceDatabase", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/database/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique pickup ID returned by the original request" } ] }, "docs": "Returns the end results of a long running request. The full URL is normally provided for you in the Location header of a finished long running response." } ] } ], "bundled": true }