mstrio-py 11.6.2.101

Python interface for the Strategy One REST API

mstrio-py: Simple and Secure Access to Strategy One Data

Installation

Prerequisites

• Python in version 3.10.x, 3.11.x, 3.12.x or 3.13.x
• MicroStrategy 2019 Update 4 (11.1.4)+

Install mstrio-py Package

Note: it is NOT recommended to install mstrio-py in an Anaconda environment. For a seamless experience, install and run it in Python's virtual environment instead.

Install latest version of mstrio-py using pip command in Terminal:

pip install mstrio-py

To install a specific, archived version of mstrio, choose the desired version available on PyPI package archive and install with pip, as follows:

pip install mstrio-py==10.11.1

Issues or specific use cases

If there are any issues with the installation process it is possible your setup may differ from usual. In that case, please see below some examples of most common situations and how to resolve them.

In all other cases, please refer to the official Python libraries installation guide.

Offline System or Proxy with Blacklisted PyPI

Note: optimally, you should contact your system administrator and either request access to PyPI or some proxy setup whitelisting all or some of the PyPI libraries.

If your setup does not allow to get packages online directly from Python Packages Index (PyPI) using pip, you can download the package manually and install it locally.

1. download .whl file from here: https://pypi.org/project/mstrio-py/#files
2. in the terminal cd into a folder where you want to install mstrio-py
3. use the command provided below after filling the path
   • py -m tells the terminal to use default install execution of python available locally on the machine
   • --user flag says "install only for my user on this machine"
4. If you have issues with py command, try the same with python instead

cd path/where/mstrio/will/be/installed
py -m pip install --user path/to/downloaded/wheel/file/mstrio-py.whl

No Python or pip Installed on the Machine

You cannot use mstrio-py without Python installed on your machine unless directly via Strategy Workstation.

Documentation

Detailed information about mstrio-py package can be found in official documentation.

Main Features

Main features of mstrio-py allows to access Strategy One data:

• Connect to your Strategy One environment using Connection class (see code_snippets)

  Note: to log into Library and use mstrio-py user needs to have UseLibrary privilege.

• Import and filter data from a OlapCube, SuperCube or Report into a Pandas DataFrame (see code_snippets)

• Export data into Strategy One by creating or updating SuperCube (see code_snippets)

Since version 11.3.0.1, mstrio-py includes also administration modules:

• Project management module (see code_snippets) with VLDB settings management (see code_snippets)
• Project languages management module (see code_snippets)
• Server management module (see code_snippets)
• User and User Group management modules (see code_snippets)
• Schedules management module (see code_snippets)
• Subscription management modules including Email Subscription, Cache Update Subscription, File Subscription, FTP Subscription, History List Subscription and Mobile Subscription (see code_snippets)
• User Library module (see code_snippets)
• User Connections management module
• Privilege and Security Role management modules (see code_snippets)
• Cube Cache management module (see code_snippets)
• Report Cache management module (see code_snippets)
• Intelligent Cube management modules (see code_snippets) with VLDB settings management (see code_snippets)
• Security filter module (see code_snippets)
• Datasources and Connection Mapping subpackage for database management (see code_snippets) with VLDB settings management (see code_snippets)
• Job Monitor module for job monitoring (see code_snippets)
• Object management module (see code_snippets)
• Contact module (see code_snippets)
• Contact Group module (see code_snippets)
• Device module (see code_snippets)
• Transmitter module (see code_snippets)
• Event module (see code_snippets)
• Migration module (see code_snippets)
• Schema Management module (see code_snippets)
• User Hierarchy module (see code_snippets)
• Attribute module (see code_snippets)
• Custom Group module (see code_snippets)
• Fact module (see code_snippets)
• Table module (see code_snippets)
• Filter module (see code_snippets)
• Transformation module (see code_snippets)
• Metric module (see code_snippets)
• Document module (see code_snippets)
• Dashboard module (see code_snippets)
• Content Cache module (see code_snippets)
• Dynamic Recipient List module (see code_snippets)
• Driver module (see code_snippets)
• Gateway module (see code_snippets)
• Language module (see code_snippets)
• Translation module (see code_snippets)
• Report module (see code_snippets)
• Incremental Refresh Report module (see code_snippets)
• Agents module (see code_snippets)
• Content Group module (see code_snippets)
• Applications module (see code_snippets)
• Fence module (see code_snippets)
• Prompt module (see code_snippets)
• Search Object module (see code_snippets)
• Script module (see code_snippets)

Versioning & Changelog

Current version: 11.6.2.101 (13 February 2026). Check out CHANGELOG to see what's new.

mstrio-py is constantly developed to support newest Strategy One REST APIs. Functionalities may be added to mstrio on monthly basis. It is recommended to always install the newest version of mstrio-py, as it will be most stable and still maintain backwards compatibility with various Strategy One installations, dating back to 11.1.4.

Features that will be added to the package but require APIs not supported by your environment (I-Server), will raise VersionException.

mstrio-py can be used for both, data-science related activities and for administrative tasks. Former requires at least MicroStrategy 2019 Update 4 (11.1.4), latter works with 11.2.1 and higher.

If you intend to use mstrio with MicroStrategy 2019 Update 3 (11.1.3) or older, refer to the PyPI package archive to download mstrio 10.11.1, which is supported on:

• MicroStrategy 2019 (11.1)
• MicroStrategy 2019 Update 1 (11.1.1)
• MicroStrategy 2019 Update 2 (11.1.2)
• MicroStrategy 2019 Update 3 (11.1.3)

Refer to the PyPI package archive for a list of available versions.

Additional Information

mstrio-py Configuration

You can customize some global mstrio-py's behavior by setting global configuration. Learn more in config code snippets.

Search for ID without additional data

mstrio-py has a dedicated method to identify what a particular object is knowing only its ID. Learn more in search actions code snippet

Deprecating Features

When features (modules, parameters, attributes, methods etc.) are marked for deprecation but still accessed, the following DeprecationWarning will be shown (example below). The functionality will continue to work until the version specified in the warning is released.

More Resources

• Learn more about mstrio-py
• Learn more about Strategy One REST API
• Strategy One REST API demo documentation