Skip to main content

API client for system:inmation.

Project description

inmation header

inmation API Client

This API client can only be used with the new inmation Web API server.


Install with pip install inmation-api-client.


  • websockets, will be installed automatically when installing with pip.


Visit the api client documentation page on the inmation's docs website for various usage examples and more.

How to use it

Advanced authentication options

  • authority can be inmation, ad (Active Directory - domain account), machine (local account)

  • username can be provided in 'User Principal Name' or 'Down-Level Logon Name'


auth authentication and authorization fields:

options = {
    'auth': {
        'username': '',
        'password': '',
        'authority': 'inmation | ad | machine',
        'grant_type': 'password',
        'include_claims': ['email', 'family_name', 'given_name', 'middle_name', 'phone_number']
    'authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'

include_claims can only be used in combination with authority set to ad. The token will not be returned to the client but passed via the req argument into ExecFunction implementation.

Note: check Web API version which authorization options its supports.

Example Active Directory authentication:

options = {
    'auth': {
        'username': '',
        'password': 'secret',
        'authority': 'ad',
        'grant_type': 'password'

Example Bearer token authentication:

options = {
    'authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...'

Example Basic authentication:

options = {
    'authorization': 'Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Connect and Read example

from inmation_api_client import Client, Options, Item

def create_client():
    options = Options({
        'auth': {
            'username': '',
            'password': 'secret',
            'authority': 'ad',
            'grant_type': 'password'
    client = Client()
    client.Connect('', 8002, options)

    def connection_changed(conn_info):
        print('Connection state: {}, authenticated: {}'.format(conn_info.state_string, conn_info.authenticated))

    def on_error(err):
        if err:
            print("Error: {}".format(err.message))

    return client

def main():
    items_path = "/System/Core/"

    # Make sure you have some items with historical data
    items = [Item(items_path + i) for i in ['Item01', 'Item02', 'Item03']]
    client = create_client()

    # Read values syncroniously
    response = client.Read(items)

if __name__ == '__main__':


inmation is a vendor-independent industrial system-integration specialist. Dedicated to modern technologies such as OPC UA (Unified Architecture) and document-oriented schema-less repositories, inmation opens up new horizons for enterprise real-time data management.

More information on



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inmation-api-client-0.8.2.tar.gz (22.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page