SLOPE offers a RESTful API to automate the repetitive tasks associated with cyclical valuation reporting.
What can I do with the Slope API?
Automate the full valuation workflow including the ingestion of files for the creation of scenario, data and decrement tables, upload of model point files, creation of projections from templates and kicking off a run. You can also check the status and pull results back down for integration into downstream systems.
Where can I access technical documentation on the available endpoints and schema?
API documentation can be found here.
Does Slope offer any sample scripts?
Yes. Slope currently offers sample scripts on Github including scripts in both Python and Java.
How do I access the Slope API?
Clients with contractual access to the SLOPE API can generate and access their API key via the gear icon in the top right of the application. To create a new API key and obtain the secret required for authentication, click “Add API Key” and provide a description.
Upon click of create you will see your API key and secret which you will need to copy and store in a secure location.
Once you have your API key and secret, you will need to use the POST
/api/v1/Authorize endpoint and provide your API key and secret to obtain your API token which is required to access all other endpoints.
To learn more about getting access to the SLOPE API, please contact your account representative.
How do I extract my results using the Slope API
To pull results via the API, use the POST Workbooks endpoint documented here
The workbook ID will be entered in the ID parameter. This is found in the url when a workbook is loaded in the Slope application.
The element ID for each tile you wish to pull via the api will also need to be included in the request. To obtain the element ID for a specific tile, click on the tile in the Slope interface and grab the element ID from the url.
How much data can I pull in a single call via the API?
The API supports downloading about 25,000 rows of data in CSV format and 20,000 rows of data in Excel format when you have 30 columns of data. Most clients need to pull more data than the limit permits. To accomplish this, they will add a Model Point Record Number and Time Period filter to pull a small number of model points across time or pull all model points for a single time period in each API call.
What is the Rate Limit for the API?
The API allows for up to 10 calls per second or 600 per minute.