{ "opencollection": "1.0.0", "info": { "name": "Factset Analytics Datastore About Calculations API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Calculations", "type": "folder" }, "items": [ { "info": { "name": "Factset Get All Fiab Calculation Summaries", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fiab/v1/calculations" }, "docs": "This endpoints returns all FIAB calculation requests." }, { "info": { "name": "Factset Run Fiab Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/fiab/v1/calculations", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a new FIAB calculation.\r\nThis must be used first before get status or cancelling endpoints with a calculation id.\r\nA successful response will contain the URL to check the status of the calculation request.\r\n\r\nRemarks:\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the FIAB template." }, { "info": { "name": "Factset Get Fiab Calculation by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fiab/v1/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Run FIAB Calculation endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested calculation." }, { "info": { "name": "Factset Get All Calculations", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations", "params": [ { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "This endpoints returns all calculation requests." }, { "info": { "name": "Factset Create and Run Pa Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs the PA calculation specified in the POST body parameters.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are B&H (Buy and Hold), TBR (Transaction based returns), OMS (Order Manageme" }, { "info": { "name": "Factset Get Pa Calculation Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" } ] }, "docs": "This is the endpoint that returns the calculation parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Pa Calculation and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the PA calculation specified in the PUT body parameters. This also allows creating new PA calculations with custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the PA template.\r\n\r\n* Account identifiers must have .ACCT or .ACTM extension or BENCH: prefix. Holdings mode can be optionally set for every account. \r\n Possible values for holdings mode are " }, { "info": { "name": "Factset Cancel Pa Calculation by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted calculation." }, { "info": { "name": "Factset Get Pa Calculation Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run PA calculation endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Pa Calculation Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/calculations/:id/units/:unitId/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get PA calculation status by id endpoint" }, { "name": "unitId", "value": "", "type": "path", "description": "from url, provided from the location header in the Get PA calculation status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in JSON." }, { "info": { "name": "Factset Starts a New Script Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/quant/fpe/v1/calculations", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint takes a python script and starts executing it within FPE" }, { "info": { "name": "Factset Get Calculation Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/quant/fpe/v1/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "From url, provided by location header or response body in the calculation start endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previous calculation request." }, { "info": { "name": "Factset Get Calculation Output for a Specific Calculation", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/quant/fpe/v1/calculations/:id/output", "params": [ { "name": "id", "value": "", "type": "path", "description": "From url, provided by location header or response body in the calculation start endpoint" } ] }, "docs": "This endpoint returns the specified output from the calculation." }, { "info": { "name": "Factset Get Calculation Log for a Specific Calculation", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/quant/fpe/v1/calculations/:id/log", "params": [ { "name": "id", "value": "", "type": "path", "description": "From url, provided by location header or response body in the calculation start endpoint" } ] }, "docs": "This endpoint returns the log from the calculation." }, { "info": { "name": "Factset Create and Run Pub Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pub/v3/calculations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs the Pub calculation specified in the POST body parameters.\r\nIt can take one or more units as input." }, { "info": { "name": "Factset Get Pub Calculation Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pub/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" } ] }, "docs": "This is the endpoint that returns the calculation parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Pub Calculation and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pub/v3/calculations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the Pub calculation specified in the PUT body parameters. This also allows creating new Pub calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range" }, { "info": { "name": "Factset Cancel Pub Calculation by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pub/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted calculation." }, { "info": { "name": "Factset Get Pub Calculation Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pub/v3/calculations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Pub calculation endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the result field in the response body will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Pub Calculation Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pub/v3/calculations/:id/units/:unitId/result", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint" }, { "name": "unitId", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Pub calculation status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in the specified format." }, { "info": { "name": "Factset Get All Calculations", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/calculations", "params": [ { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "This endpoints returns all calculation requests." }, { "info": { "name": "Factset Create and Run Quant Engine Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/calculations", "headers": [ { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs the Quant Engine calculation specified in the POST body parameters.\r\nIt can take one or more calculation units as input." }, { "info": { "name": "Factset Get Quant Engine Calculation Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" } ] }, "docs": "This is the endpoint that returns the calculation parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Quant Engine Calculation and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/calculations/:id", "headers": [ { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and runs the Quant Engine calculation specified in the PUT body parameters. This also allows creating new Quant Engine calculations with custom ids.\r\nIt can take one or more calculation units as input." }, { "info": { "name": "Factset Cancel Quant Calculation by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Quant calculation endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted calculation." }, { "info": { "name": "Factset Get Quant Engine Calculation Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/calculations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Quant Engine calculation endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Quant Engine Calculation Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/calculations/:id/units/:unitId/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint" }, { "name": "unitId", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Quant Engine calculation status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in JSON." }, { "info": { "name": "Factset Get Quant Engine Calculation Metadata Information by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/calculations/:id/units/:unitId/info", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint" }, { "name": "unitId", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Quant calculation status by id endpoint" } ] }, "docs": "This is the endpoint to get the metadata information of a previously requested calculation." }, { "info": { "name": "Factset Get All Calculations", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations", "params": [ { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "This endpoints returns all calculation requests." }, { "info": { "name": "Factset Create and Run Spar Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs the SPAR calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override over the settings saved in the SPAR template." }, { "info": { "name": "Factset Get Spar Calculation Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" } ] }, "docs": "This is the endpoint that returns the calculation parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Spar Calculation and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the SPAR calculation specified in the PUT body parameters. This also allows creating new SPAR calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override over the settings saved in the SPAR template." }, { "info": { "name": "Factset Cancel Spar Calculation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted calculation." }, { "info": { "name": "Factset Get Spar Calculation Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run SPAR calculation endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url." }, { "info": { "name": "Factset Get Spar Calculation Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/calculations/:id/units/:unitId/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" }, { "name": "unitId", "value": "", "type": "path", "description": "from url, provided from the location header in the Get SPAR calculation status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in JSON." }, { "info": { "name": "Factset Get All Calculations", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations", "params": [ { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "This endpoints returns all calculation requests." }, { "info": { "name": "Factset Create and Run Vault Calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs the Vault calculation specified in the POST body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range" }, { "info": { "name": "Factset Get Vault Calculation Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" } ] }, "docs": "This is the endpoint that returns the calculation parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Vault Calculation and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations/:id", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the Vault calculation specified in the PUT body parameters. This also allows creating new Vault calculations with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\n\r\n* Start and and end date must be within the configuration's min and max date range" }, { "info": { "name": "Factset Cancel Vault Calculation by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted calculation." }, { "info": { "name": "Factset Get Vault Calculation Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Vault calculation endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url." }, { "info": { "name": "Factset Get Vault Calculation Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/calculations/:id/units/:unitId/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Vault calculation status by id endpoint" }, { "name": "unitId", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Vault calculation status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested calculation.\r\nIf the calculation has finished computing, the body of the response will contain the requested document in JSON." } ] } ], "bundled": true }