{ "opencollection": "1.0.0", "info": { "name": "Factset Datastore About Analytics API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Analytics", "type": "folder" }, "items": [ { "info": { "name": "Factset Redirects to the raw PPT/PDF output created by the Publisher service.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:accountId/:date", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Publisher document containing the report" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" }, { "name": "date", "value": "2023-01-01", "type": "path", "description": "The as of date for the report" } ] }, "docs": "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Redirects to the underlying PA/SPAR data represented in a Stach format, with no as of date specified.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:assetName/:reportId/:tileId/:accountId", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Publisher or Analytics Datafeed document containing the report" }, { "name": "assetName", "value": "ADS_Demo.PA3", "type": "path", "description": "The PA/SPAR asset name and extension" }, { "name": "reportId", "value": "report7", "type": "path", "description": "The PA/SPAR report ID" }, { "name": "tileId", "value": "tile0", "type": "path", "description": "The PA/SPAR tile ID" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" } ] }, "docs": "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Redirects to the underlying PA/SPAR data represented in a Stach format.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:assetName/:reportId/:tileId/:accountId/:date", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Publisher or Analytics Datafeed document containing the report" }, { "name": "assetName", "value": "ADS_Demo.PA3", "type": "path", "description": "The PA/SPAR asset name and extension" }, { "name": "reportId", "value": "report7", "type": "path", "description": "The PA/SPAR report ID" }, { "name": "tileId", "value": "tile0", "type": "path", "description": "The PA/SPAR tile ID" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" }, { "name": "date", "value": "2023-01-01", "type": "path", "description": "The as of date for the report" } ] }, "docs": "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Redirects to the underlying Insight/Vault data in a Stach format.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/swivel/v1/:document/:assetName/:reportId/:tileId/:accountId/:configId/:date", "params": [ { "name": "document", "value": "Analytics_Datastore", "type": "path", "description": "The Analytics Datafeed document containing the report" }, { "name": "assetName", "value": "ADS_Demo.PA3", "type": "path", "description": "The PA/SPAR asset name and extension" }, { "name": "reportId", "value": "report7", "type": "path", "description": "The PA/SPAR report ID" }, { "name": "tileId", "value": "tile0", "type": "path", "description": "The PA/SPAR tile ID" }, { "name": "accountId", "value": "LARGE_CORE", "type": "path", "description": "The account ID" }, { "name": "configId", "value": "acb5150d-4333-49e7-8e33-4f7fa749691e", "type": "path", "description": "The Vault configuration ID" }, { "name": "date", "value": "2023-01-01", "type": "path", "description": "The as of date for the report" } ] }, "docs": "The inclusion of a configId in the path indicates this is for Insight/Vault mappings only, as PA/SPAR mappings do not support the concept of configuration id.\r\n\r\nTakes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." }, { "info": { "name": "Factset Gets an object given an ID. In this case ID retrieved from mapping Location header, object data in response body.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/cargo/v1/groups/:groupId/objects/:objectId", "params": [ { "name": "groupId", "value": "a4186c50f8e74f979d271dd22298c901", "type": "path", "description": "The ID of the group" }, { "name": "objectId", "value": "fe875bc4150542dea6bc237663a01a0d", "type": "path", "description": "The ID of the object" } ] }, "docs": "Raw object data can be found in the response body. This can be either the mapped PDF/PPT or STACH json, depending on the mapping. https://pages.github.factset.com/analytics-reporting/stachschema/#/ \r\n\nOptional request header \"accept-encoding\", with allowed values of \"br\" and \"gzip\". If accept-encoding is passed, the response is compressed." }, { "info": { "name": "Factset Gets a list of Documents that a user has access to.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/documents/search", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves metadata around documents stored in the Analytics Datastore Service. Each Document will have a 'url' property which will act as a re-direct to the underlying document data\r\n\r\nThis end point supports pagination and filtering through the use of the request body listed below.\r\n\r\nTo discover what tags are available to filter on, see GET /tags and GET /tags/{name}/values to retrieve these filter values.\r\n\r\nSimilarly, to discover what product types are available to filter on, see POST /produ" }, { "info": { "name": "Factset Gets a list of tag definitions for the user.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/tags", "params": [ { "name": "_paginationOffset", "value": "", "type": "query", "description": "The offset integer on where to begin paginating" }, { "name": "_paginationLimit", "value": "", "type": "query", "description": "The limit of records to return when paginating" } ] }, "docs": "Tag definitions consist of a name and a type. Use this end point to see a list of pre-existing tags that can be used to filter on the Documents end point." }, { "info": { "name": "Factset Get a single tag definition based on its name", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/tags/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the tag" } ] }, "docs": "Retrieve a tag definition based on its name" }, { "info": { "name": "Factset Gets a list of tag values for the given name", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/tags/:name/values", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the tag" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of tag values depending on the name provided. Supports filtering on additional tag name value pairs, which operates as an 'AND' where the Document must have the tag name specified in the path AND the filtered parameter." }, { "info": { "name": "Factset Gets a list of product types that a user has access to.", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/pub-datastore/tag-search/v1/product-types/search", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves a list of product types that have been specified across all documents the user has access to" }, { "info": { "name": "Factset Get accounts and sub-directories in a directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/lookups/v3/accounts/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the accounts and sub-directories in" } ] }, "docs": "This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory." }, { "info": { "name": "Factset Create and Run Axioma optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/axp/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs Axioma optimization specified in the POST body parameters.\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 strategy document." }, { "info": { "name": "Factset Get Axioma optimization parameters by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/axp/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Axioma optimization and run it.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/axp/v3/optimizations/: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 Axioma optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the Axioma optimization specified in the PUT body parameters. It also allows the creation of new Axioma optimization with custom id." }, { "info": { "name": "Factset Cancel Axioma optimization by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/axp/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get Axioma optimization status by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/axp/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run Axioma optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Axioma optimization result by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/axp/v3/optimizations/:id/result", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get Axioma optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization." }, { "info": { "name": "Factset Get currencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/lookups/v3/currencies" }, "docs": "This endpoint lists all the currencies that can be applied to any calculation." }, { "info": { "name": "Factset Get Axioma Equity strategy documents and sub-directories in a directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/axp/v3/strategies/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the strategy documents and sub-directories in" } ] }, "docs": "This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory." }, { "info": { "name": "Factset Create and Run AFI optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs AFI optimization specified in the POST body parameters.\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 strategy document." }, { "info": { "name": "Factset Get AFI optimization parameters by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for an optimization." }, { "info": { "name": "Factset Create or Update AFI optimization and run it.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/: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 AFI optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the AFI optimization specified in the PUT body parameters. It also allows the creation of new AFI optimization with custom id." }, { "info": { "name": "Factset Cancel AFI optimization by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get AFI optimization status by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run AFI optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get AFI optimization result by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/optimizations/:id/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get AFI optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization." }, { "info": { "name": "Factset Get Axioma FI strategy documents and sub-directories in a directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/afi/v3/strategies/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the strategy documents and sub-directories in" } ] }, "docs": "This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory." }, { "info": { "name": "Factset Create and Run BPM optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/bpm/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs BPM optimization specified in the POST body parameters.\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 strategy document." }, { "info": { "name": "Factset Get BPM optimization parameters by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/bpm/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for an optimization." }, { "info": { "name": "Factset Create or Update BPM optimization and run it.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/bpm/v3/optimizations/: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 BPM optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the BPM optimization specified in the PUT body parameters. It also allows the creation of new BPM optimization with custom id." }, { "info": { "name": "Factset Cancel BPM optimization by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/bpm/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get BPM optimization status by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/bpm/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run BPM optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get BPM optimization result by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/bpm/v3/optimizations/:id/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get BPM optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization." }, { "info": { "name": "Factset Get Barra strategy documents and sub-directories in a directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/bpm/v3/strategies/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the strategy documents and sub-directories in" } ] }, "docs": "This endpoint looks up all Barra strategy documents and sub-directories in a given directory." }, { "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 Create and Run Npo Optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs NPO optimization specified in the POST body parameters.\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 strategy document." }, { "info": { "name": "Factset Get Npo Optimization Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for an optimization." }, { "info": { "name": "Factset Create or Update Npo Optimization and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/: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 NPO optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the NPO optimization specified in the PUT body parameters. It also allows the creation of new NPO optimization with custom id." }, { "info": { "name": "Factset Cancel Npo Optimization by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get Npo Optimization Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run NPO optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Npo Optimization Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/optimizations/:id/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get NPO optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization." }, { "info": { "name": "Factset Get Northfield Strategy Documents and Sub-directories in a Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/npo/v3/strategies/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the strategy documents and sub-directories in" } ] }, "docs": "This endpoint looks up all Northfield strategy documents and sub-directories in a given directory." }, { "info": { "name": "Factset Get Pa Columns", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/columns", "params": [ { "name": "name", "value": "", "type": "query", "description": "Column name" }, { "name": "category", "value": "", "type": "query", "description": "Column category" }, { "name": "directory", "value": "", "type": "query", "description": "The directory to get the columns in" } ] }, "docs": "This endpoint lists all the PA columns that can be applied to a calculation." }, { "info": { "name": "Factset Get Pa Column Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/columns/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a column" } ] }, "docs": "This endpoint returns the default settings of a PA column." }, { "info": { "name": "Factset Get Pa Column Statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/columnstatistics" }, "docs": "This endpoint lists all the column statistics that can be applied to a PA column." }, { "info": { "name": "Factset Get Pa Components", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/components", "params": [ { "name": "document", "value": "", "type": "query", "description": "Document Name" } ] }, "docs": "This endpoint returns the list of PA components in a given PA document." }, { "info": { "name": "Factset Get Pa Component by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/components/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a PA component" } ] }, "docs": "This endpoint returns the default settings of a PA component." }, { "info": { "name": "Factset Convert Pa Dates to Absolute Format", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/dates", "params": [ { "name": "startdate", "value": "", "type": "query", "description": "Start Date" }, { "name": "enddate", "value": "", "type": "query", "description": "End Date" }, { "name": "componentid", "value": "", "type": "query", "description": "Component Id" }, { "name": "account", "value": "", "type": "query", "description": "Account ( Account Name ending with .ACCT or .ACTM )" } ] }, "docs": "This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal." }, { "info": { "name": "Factset Get Pa3 Documents and Sub-directories in a Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/documents/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the documents and sub-directories in" } ] }, "docs": "This endpoint looks up all PA3 documents and sub-directories in a given directory." }, { "info": { "name": "Factset Get Pa Frequencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/frequencies" }, "docs": "This endpoint lists all the frequencies that can be applied to a PA calculation." }, { "info": { "name": "Factset Get Pa Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/groups" }, "docs": "This endpoint lists all the PA groups that can be applied to a PA calculation." }, { "info": { "name": "Factset Get Pa Grouping Frequencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/grouping-frequencies" }, "docs": "This endpoint lists all the PA grouping frequencies that can be applied to a PA calculation." }, { "info": { "name": "Factset Get Linked Pa Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Get linked PA templates in path." }, { "name": "documentDirectory", "value": "", "type": "query", "description": "Get linked PA templates for documents in document path" }, { "name": "documentName", "value": "", "type": "query", "description": "Get linked PA templates for documents by document name" } ] }, "docs": "This endpoint returns the list of linked PA templates in given path." }, { "info": { "name": "Factset Create a Linked Pa Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a template from an **existing portfolio analysis tile**, allowing the user to replicate and fetch reports settings.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\"" }, { "info": { "name": "Factset Get Linked Pa Template by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a linked PA template" } ] }, "docs": "This endpoint fetches the linked PA template settings." }, { "info": { "name": "Factset Update a Linked Pa Template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a linked PA template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows the user to change the request body and description from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdeta" }, { "info": { "name": "Factset Delete a Linked Pa Template.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pa/v3/linked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a linked PA template" } ] }, "docs": "This endpoint deletes an existing linked PA template." }, { "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 Get Pa Pricing Sources", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/pricing-sources", "params": [ { "name": "name", "value": "", "type": "query", "description": "PA pricing sources name" }, { "name": "category", "value": "", "type": "query", "description": "PA pricing sources category" }, { "name": "directory", "value": "", "type": "query", "description": "The directory to get the PA pricing sources in" } ] }, "docs": "This endpoint lists all the PA pricing sources that can be applied to a PA calculation." }, { "info": { "name": "Factset Get Templated Pa Components in Path", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/templated-components", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Get templated PA components in path" } ] }, "docs": "This endpoint returns the list of templated PA components in path." }, { "info": { "name": "Factset Create Templated Pa Component", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pa/v3/templated-components", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates new component based off of linked PA template or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the 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 Management System), \r\n VLT (Vaulted " }, { "info": { "name": "Factset Get Templated Pa Component by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/templated-components/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a templated PA component" } ] }, "docs": "This endpoint fetches the templated PA component settings." }, { "info": { "name": "Factset Update Templated Pa Component", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pa/v3/templated-components/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a templated PA component" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows the user to change the request body from an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings in the 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 Management System), \r\n VLT (Vau" }, { "info": { "name": "Factset Delete Templated Pa Component", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pa/v3/templated-components/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a templated PA component" } ] }, "docs": "This endpoint deletes an existing templated PA component" }, { "info": { "name": "Factset Get Unlinked Pa Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates", "params": [ { "name": "directory", "value": "", "type": "query", "description": "Get unlinked PA templates in path." }, { "name": "category", "value": "", "type": "query", "description": "Get unlinked PA templates by category." } ] }, "docs": "This endpoint returns the list of unlinked PA templates." }, { "info": { "name": "Factset Create Unlinked Pa Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a template which is not linked to any specific PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We canno" }, { "info": { "name": "Factset Get Unlinked Pa Template Details by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template" } ] }, "docs": "This endpoint fetches the template settings." }, { "info": { "name": "Factset Update Unlinked Pa Template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing unlinked PA template.\r\n\r\nRemarks:\r\n \r\n* Mandatory fields are required to be passed in POST requests and Optional fields are not necessary. \r\n If no mandatory fields are passed, then we can use the template as a component and skip the component creation.\r\n \r\n* Mandatory, optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot override t" }, { "info": { "name": "Factset Delete Unlinked Pa Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template" } ] }, "docs": "This endpoint deletes an existing unliked PA template." }, { "info": { "name": "Factset Get Default Unlinked Pa Template Types.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/template-types" }, "docs": "This endpoint fetches default unlinked PA template types." }, { "info": { "name": "Factset Get Unlinked Pa Template Type Details by Id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pa/v3/unlinked-templates/template-types/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for an unlinked PA template type" } ] }, "docs": "This endpoint fetches the unlinked PA template type details." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data" }, { "info": { "name": "Factset Create or Update an Existing Model Account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/accounts/v3/models/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the model account to create or update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Factset Create or Update an Existing Model Account" }, { "info": { "name": "Factset Delete Model Account, Takes an Account Path and Name and Deletes It.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/accounts/v3/models/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of model account to delete" } ] }, "docs": "Factset Delete Model Account, Takes an Account Path and Name and Deletes It." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name, Symbol and Returns Underlying Data for That Symbol", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/symbols/:symbol", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "symbol", "value": "", "type": "path", "description": "The symbol for which data needs to be updated" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name, Symbol and Returns Underlying Data for That Symbol" }, { "info": { "name": "Factset Delete All Entries for a Symbol or Specific Date Entries for a Symbol From a Previously Created Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/symbols/:symbol", "params": [ { "name": "name", "value": "", "type": "path", "description": "The filename of model account to delete" }, { "name": "symbol", "value": "", "type": "path", "description": "The symbol from the given file name to delete" }, { "name": "dates", "value": "", "type": "query", "description": "The dates from the given file name and symbol to delete (Maximum 10 dates are allowed)" } ] }, "docs": "Factset Delete All Entries for a Symbol or Specific Date Entries for a Symbol From a Previously Created Account." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name, Date and Returns Underlying Data for That Date", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/dates/:date", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "date", "value": "", "type": "path", "description": "The date for which data needs to be updated" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name, Date and Returns Underlying Data for That Date" }, { "info": { "name": "Factset Delete All Entries for a Date or Specific Symbol Entries for a Date From a Previously Created Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/dates/:date", "params": [ { "name": "name", "value": "", "type": "path", "description": "The filename of model account to delete" }, { "name": "date", "value": "", "type": "path", "description": "The date from the given file name to delete" }, { "name": "symbols", "value": "", "type": "query", "description": "The symbols from the given file name and date to delete (Maximum 10 symbols are allowed)" } ] }, "docs": "Factset Delete All Entries for a Date or Specific Symbol Entries for a Date From a Previously Created Account." }, { "info": { "name": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/dates/:date/symbols/:symbol", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get" }, { "name": "symbol", "value": "", "type": "path", "description": "The symbol for which data needs to be updated" }, { "name": "date", "value": "", "type": "path", "description": "The date for which data needs to be updated" }, { "name": "format", "value": "", "type": "query", "description": "Optional format for the response, supported formats are JsonStach and AccountModel" } ] }, "docs": "Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data" }, { "info": { "name": "Factset Get Account Schema Endpoint, Takes an Account Name and Returns Its Schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/accounts/v3/models/:name/schema", "params": [ { "name": "name", "value": "", "type": "path", "description": "The path and filename of the account to get its schema" } ] }, "docs": "Factset Get Account Schema Endpoint, Takes an Account Name and Returns Its Schema" }, { "info": { "name": "Factset Create and Run Fpo Optimization", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint runs FPO optimization specified in the POST body parameters.\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 strategy document." }, { "info": { "name": "Factset Get Fpo Optimization Parameters by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ] }, "docs": "This is the endpoint that returns the optimization parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update Fpo Optimization and Run It.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/: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 FPO optimization endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the FPO optimization specified in the PUT body parameters. It also allows the creation of new FPO optimization with custom id." }, { "info": { "name": "Factset Cancel Fpo Optimization by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted optimization." }, { "info": { "name": "Factset Get Fpo Optimization Status by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FPO optimization endpoint" } ] }, "docs": "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get Fpo Optimization Result by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/optimizations/:id/result", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get FPO optimization status by id endpoint" } ] }, "docs": "This is the endpoint to get the result of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON." }, { "info": { "name": "Get Factset Portfolio Optimizer Strategy Documents and Sub-directories in a Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fpo/v3/strategies/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the strategy documents and sub-directories in" } ] }, "docs": "This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory." }, { "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 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 Gets Publisher Documents and Sub-directories in a Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/pub/v3/documents/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the documents in" } ] }, "docs": "This endpoint looks up all Publisher documents and sub-directories in a given directory." }, { "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 Existing Securities", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/security-modeling/v3/securities/retrieve", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint gets all existing securities." }, { "info": { "name": "Factset Create or Update Securities", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/security-modeling/v3/securities/upsert", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is to create or update existing securities." }, { "info": { "name": "Factset Delete Existing Securities", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/security-modeling/v3/securities/delete", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint deletes existing securities." }, { "info": { "name": "Factset Get Spar Account Returns Type Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/accounts/:accountPath/returns-type", "params": [ { "name": "accountPath", "value": "", "type": "path", "description": "URL encoded account path" } ] }, "docs": "This endpoint returns the returns type of account associated with SPAR" }, { "info": { "name": "Factset Get Spar Benchmark Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/benchmarks", "params": [ { "name": "id", "value": "", "type": "query", "description": "Benchmark Identifier" } ] }, "docs": "This endpoint returns the details of a given SPAR benchmark identifier." }, { "info": { "name": "Factset Get Spar Components", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/components", "params": [ { "name": "document", "value": "", "type": "query", "description": "Document Name" } ] }, "docs": "This endpoint returns the list of SPAR components in a given SPAR document." }, { "info": { "name": "Factset Get Spar Component by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/components/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a SPAR component" } ] }, "docs": "This endpoint returns the default settings of a SPAR component." }, { "info": { "name": "Factset Gets Spar3 Documents and Sub-directories in a Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/documents/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the documents in" } ] }, "docs": "This endpoint looks up all SPAR3 documents and sub-directories in a given directory." }, { "info": { "name": "Factset Get Spar Frequencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/spar/v3/frequencies" }, "docs": "This endpoint lists all the frequencies that can be applied to a SPAR 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 Vault Components", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/components", "params": [ { "name": "document", "value": "", "type": "query", "description": "Document Name" } ] }, "docs": "This endpoint returns the list of Vault components in a given Vault document." }, { "info": { "name": "Factset Get Vault Component by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/components/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for a vault component" } ] }, "docs": "This endpoint returns the default settings of a Vault component." }, { "info": { "name": "Factset Get Vault Configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/configurations", "params": [ { "name": "account", "value": "", "type": "query", "description": "Required account query parameter to filter configurations for a specific account" } ] }, "docs": "This endpoint returns all the Vault configurations saved in the provided account." }, { "info": { "name": "Factset Get Vault Configuration by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Vault configuration id to get the details of" } ] }, "docs": "This endpoint returns details for a Vault configuration as well as a list of accounts it is used in." }, { "info": { "name": "Factset Convert Vault Dates to Absolute Format", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/dates", "params": [ { "name": "startdate", "value": "", "type": "query", "description": "Start Date" }, { "name": "enddate", "value": "", "type": "query", "description": "End Date" }, { "name": "componentid", "value": "", "type": "query", "description": "Vault Component Id" }, { "name": "account", "value": "", "type": "query", "description": "Account" } ] }, "docs": "This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal." }, { "info": { "name": "Factset Get Vault Documents and Sub-directories in a Directory", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/documents/:path", "params": [ { "name": "path", "value": "", "type": "path", "description": "The directory to get the documents in" } ] }, "docs": "This endpoint looks up all Vault documents and sub-directories in a given directory." }, { "info": { "name": "Factset Get Vault Frequencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/vault/v3/frequencies" }, "docs": "This endpoint lists all the frequencies that can be applied to a Vault calculation." }, { "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." }, { "info": { "name": "Factset Get Discount Curves", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fi/v3/discount-curves", "params": [ { "name": "currency", "value": "", "type": "query" } ] }, "docs": "This endpoint lists all the discount curves that can be applied to a FI calculation." }, { "info": { "name": "Factset Create and Run FI calculation", "type": "http" }, "http": { "method": "POST", "url": "https://api.factset.com/analytics/engines/fi/v3/calculations", "headers": [ { "name": "X-FactSet-Api-Long-Running-Deadline", "value": "" }, { "name": "Cache-Control", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates and runs a new FI calculation specified in the post body." }, { "info": { "name": "Factset Get FI calculation parameters by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fi/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" } ] }, "docs": "This is the endpoint that returns the calculation parameters passed for a calculation." }, { "info": { "name": "Factset Create or Update FI calculation and run it.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.factset.com/analytics/engines/fi/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 FI calculation endpoint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates and run the FI optimization specified in the PUT body parameters. It also allows the creation of new FI optimization with custom id." }, { "info": { "name": "Factset Cancel FI calculation by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.factset.com/analytics/engines/fi/v3/calculations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FI calculation endpoint" } ] }, "docs": "This is the endpoint to cancel a previously submitted calculation." }, { "info": { "name": "Factset Get FI calculation status by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fi/v3/calculations/:id/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Create and Run FI 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 body of the response will contain the requested document in JSON.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." }, { "info": { "name": "Factset Get FI calculation result by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.factset.com/analytics/engines/fi/v3/calculations/:id/result", "params": [ { "name": "id", "value": "", "type": "path", "description": "from url, provided from the location header in the Get FI 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 }