Skip to main content

Implementation of Mikrotik API

Project description


Build Status

RouterOS is a API client for Mikrotik RouterOS.

How can I install it?

$ pip install routeros 

The usage of a virtualenv is recommended.

How to use it?

In [1]: from routeros import login

In [2]: routeros = login('user', 'password', '')

In [3]: routeros('/ip/pool/print')
({'.id': '*1', 'name': 'dhcp', 'ranges': ''},
 {'.id': '*2', 'name': 'hs-pool-8', 'ranges': ''})

In [4]: routeros.close()

In [5]: 

Also can use query

Query can consult specific attributes on routeros.


  • query.has(*args)
  • query.hasnot(*args)
  • query.equal(**kwargs)
  • query.lower(**kwargs)
  • query.greater(**kwargs)
In [1]: from routeros import login

In [2]: routeros = login('user', 'password', '')

In [3]: routeros.query('/ip/pool/print').equal(name='dhcp')
Out[3]: ({'.id': '*1', 'name': 'dhcp', 'ranges': ''},)

In [4]: routeros.close()

In [5]: 

How to use non-default (8728) API port for login, such as 9999

routeros = login('user', 'password', '', 9999)

How to use pre-v6.43 login method

routeros = login('user', 'password', '', 8728, True)

Project details

Download files

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

Files for routeros, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size routeros-0.1.1-py2.py3-none-any.whl (6.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size routeros-0.1.1.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page